-
Notifications
You must be signed in to change notification settings - Fork 116
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #245 from nutanix/readme-v1.2.0
Update README and Website for v1.2.0 release.
- Loading branch information
Showing
13 changed files
with
508 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
layout: "nutanix" | ||
page_title: "NUTANIX: nutanix_karbon_cluster_kubeconfig" | ||
sidebar_current: "docs-nutanix-datasource-karbon-cluster-kubeconfig" | ||
description: |- | ||
Describes the SSH config from a Karbon Cluster | ||
--- | ||
|
||
# nutanix_karbon_cluster_kubeconfig | ||
|
||
Describes the SSH config from a Karbon Cluster | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
# Get kubeconfig by cluster UUID | ||
data "nutanix_karbon_cluster_kubeconfig" "configbyid" { | ||
karbon_cluster_id = "<YOUR-CLUSTER-ID>" | ||
} | ||
# Get Kubeconfig by cluster name | ||
data "nutanix_karbon_cluster_kubeconfig" "configbyname" { | ||
karbon_cluster_name = "<YOUR-CLUSTER-NAME>" | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `karbon_cluster_id`: Represents karbon cluster uuid | ||
* `karbon_cluster_name`: Represents the name of karbon cluster | ||
|
||
## Attribute Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `name` | ||
* `access_token` | ||
* `cluster_ca_certificate` | ||
* `cluster_url` | ||
|
||
See detailed information in [Get Nutanix Karbon Cluster KubeConfig](https://www.nutanix.dev/reference/karbon/api-reference/cluster/getk8sclusterkubeconfig/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
layout: "nutanix" | ||
page_title: "NUTANIX: nutanix_karbon_cluster_ssh" | ||
sidebar_current: "docs-nutanix-datasource-karbon-cluster-ssh" | ||
description: |- | ||
Describes the SSH config from a Karbon Cluster | ||
--- | ||
|
||
# nutanix_karbon_cluster_ssh | ||
|
||
Describes the SSH config from a Karbon Cluster | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
# Get ssh credentials by cluster UUID | ||
data "nutanix_karbon_cluster_ssh" "sshbyid" { | ||
karbon_cluster_id = "<YOUR-CLUSTER-ID>" | ||
} | ||
# Get ssh credentials by cluster name | ||
data "nutanix_karbon_cluster_ssh" "sshbyname" { | ||
karbon_cluster_name = "<YOUR-CLUSTER-NAME>" | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `karbon_cluster_id`: Represents karbon cluster uuid | ||
* `karbon_cluster_name`: Represents the name of karbon cluster | ||
|
||
## Attribute Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `certificate` Certificate of the user for SSH access. | ||
* `expiry_time` Timestamp of certificate expiry in the ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ). | ||
* `private_key` The private key of the user for SSH access. | ||
* `username` The username for which credentials are returned. | ||
|
||
See detailed information in [Get Nutanix Karbon Cluster SSH Credentials](https://www.nutanix.dev/reference/karbon/api-reference/cluster/getk8sclustersshaccess/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
--- | ||
layout: "nutanix" | ||
page_title: "NUTANIX: nutanix_permission" | ||
sidebar_current: "docs-nutanix-datasource-permission" | ||
description: |- | ||
Describe a Nutanix Permission and its values (if it has them). | ||
--- | ||
|
||
# nutanix_permission | ||
|
||
Describe a Nutanix Permission and its values (if it has them). | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
#Get permission by UUID | ||
data "nutanix_permission" "byuuid" { | ||
permission_id = "26b81a55-2bca-48c6-9fab-4f82c6bb4284" | ||
} | ||
#Get permission by name | ||
data "nutanix_permission" "byname" { | ||
permission_name = "Access_Console_Virtual_Machine" | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `permission_id`: (ConflictsWith: `permission_name`) The `id` of the permission. | ||
* `permission_name`: (ConflictsWith: `permission_id`) The `name` of the permission. | ||
|
||
## Attributes Reference | ||
|
||
The following attributes are exported: | ||
|
||
|
||
* `metadata`: The permission kind metadata. | ||
* `categories`: The categories for this resource. | ||
* `owner_reference`: The reference to a user. | ||
* `project_reference`: The reference to a project. | ||
* `name` The name for the permission. | ||
* `state`: The state of the permission. | ||
* `description` A description for the permission. | ||
* `operation` The operation that is being performed on a given kind. | ||
* `kind` The kind on which the operation is being performed. | ||
* `fields` . The fields that can/cannot be accessed during the specified operation. field_name_list will be a list of fields. e.g. if field_mode = disallowed, field_name_list = [“xyz”] then the list of allowed fields is ALL fields minus xyz. Seee [Field](#field) for more info. | ||
|
||
### Field | ||
|
||
The field attribute exports the following: | ||
|
||
* `field_mode` Allow or disallow the fields mentioned. | ||
* `field_name_list` The list of fields. | ||
|
||
### Metadata | ||
|
||
The metadata attribute exports the following: | ||
|
||
* `last_update_time` - UTC date and time in RFC-3339 format when the permission was last updated. | ||
* `uuid` - Permission UUID. | ||
* `creation_time` - UTC date and time in RFC-3339 format when the permission was created. | ||
* `spec_version` - Version number of the latest spec. | ||
* `spec_hash` - Hash of the spec. This will be returned from server. | ||
* `name` - Permission name. | ||
* `should_force_translate`: - Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema. | ||
|
||
### Categories | ||
The categories attribute supports the following: | ||
|
||
* `name` - the key name. | ||
* `value` - value of the key. | ||
|
||
### Reference | ||
The `project_reference`, `owner_reference` attributes supports the following: | ||
|
||
* `kind` - (Required) The kind name (Default value: `project`). | ||
* `name` - the name. | ||
* `uuid` - (Required) the UUID. | ||
|
||
See detailed information in [Nutanix Permission](https://www.nutanix.dev/reference/prism_central/v3/api/permissions/getpermissionsuuid/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
--- | ||
layout: "nutanix" | ||
page_title: "NUTANIX: nutanix_permissions" | ||
sidebar_current: "docs-nutanix-datasource-permissions" | ||
description: |- | ||
Provides a datasource to retrieve all the permissions. | ||
--- | ||
|
||
# nutanix_permission | ||
|
||
Provides a datasource to retrieve all the permissions. | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
data "nutanix_permission" "permissions" {} | ||
``` | ||
|
||
## Attributes Reference | ||
|
||
The following attributes are exported: | ||
|
||
* `api_version`: version of the API | ||
* `entities`: List of Permissions | ||
|
||
# Entities | ||
|
||
The entities attribute element contains the following attributes: | ||
|
||
* `metadata`: The permission kind metadata. | ||
* `categories`: The categories for this resource. | ||
* `owner_reference`: The reference to a user. | ||
* `project_reference`: The reference to a project. | ||
* `name` The name for the permission. | ||
* `state`: The state of the permission. | ||
* `description` A description for the permission. | ||
* `operation` The operation that is being performed on a given kind. | ||
* `kind` The kind on which the operation is being performed. | ||
* `fields` . The fields that can/cannot be accessed during the specified operation. field_name_list will be a list of fields. e.g. if field_mode = disallowed, field_name_list = [“xyz”] then the list of allowed fields is ALL fields minus xyz. Seee [Field](#field) for more info. | ||
|
||
### Field | ||
|
||
The field attribute exports the following: | ||
|
||
* `field_mode` Allow or disallow the fields mentioned. | ||
* `field_name_list` The list of fields. | ||
|
||
### Metadata | ||
|
||
The metadata attribute exports the following: | ||
|
||
* `last_update_time` - UTC date and time in RFC-3339 format when the permission was last updated. | ||
* `uuid` - permission UUID. | ||
* `creation_time` - UTC date and time in RFC-3339 format when the permission was created. | ||
* `spec_version` - Version number of the latest spec. | ||
* `spec_hash` - Hash of the spec. This will be returned from server. | ||
* `name` - permission name. | ||
* `should_force_translate`: - Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema. | ||
|
||
### Categories | ||
The categories attribute supports the following: | ||
|
||
* `name` - the key name. | ||
* `value` - value of the key. | ||
|
||
### Reference | ||
The `project_reference`, `owner_reference` attributes supports the following: | ||
|
||
* `kind` - (Required) The kind name (Default value: `project`). | ||
* `name` - the name. | ||
* `uuid` - (Required) the UUID. | ||
|
||
See detailed information in [Nutanix Permissions](https://www.nutanix.dev/reference/prism_central/v3/api/permissions/postpermissionslist/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.