Skip to content

Commit

Permalink
Merge pull request #245 from nutanix/readme-v1.2.0
Browse files Browse the repository at this point in the history
Update README and Website for  v1.2.0 release.
  • Loading branch information
marinsalinas authored Feb 1, 2021
2 parents 1478551 + 2c29510 commit 8576511
Show file tree
Hide file tree
Showing 13 changed files with 508 additions and 73 deletions.
59 changes: 44 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Terraform provider plugin to integrate with Nutanix Enterprise Cloud

NOTE: The latest version of the Nutanix provider is [v1.1.1](https://github.com/nutanix/terraform-provider-nutanix/releases/tag/v1.1.1)
NOTE: The latest version of the Nutanix provider is [v1.2.0](https://github.com/nutanix/terraform-provider-nutanix/releases/tag/v1.2.0)

## Build, Quality Status

Expand Down Expand Up @@ -60,27 +60,56 @@ provider "nutanix" {

## Resources

* nutanix_virtual_machine
* nutanix_subnet
* nutanix_network_security_rule
* nutanix_image
* nutanix_category_value
* nutanix_access_control_policy
* nutanix_category_key
* nutanix_category_value
* nutanix_image
* nutanix_karbon_cluster
* nutanix_karbon_private_registry
* nutanix_network_security_rule
* nutanix_project
* nutanix_protection_rule
* nutanix_recovery_plan
* nutanix_role
* nutanix_subnet
* nutanix_user
* nutanix_virtual_machine


## Data Sources

* nutanix_virtual_machine
* nutanix_subnet
* nutanix_subnets
* nutanix_network_security_rule
* nutanix_image
* nutanix_host
* nutanix_hosts
* nutanix_access_control_policies
* nutanix_access_control_policy
* nutanix_category_key
* nutanix_cluster
* nutanix_clusters
* nutanix_category_key

* nutanix_host
* nutanix_hosts
* nutanix_image
* nutanix_karbon_cluster_kubeconfig
* nutanix_karbon_cluster_ssh
* nutanix_karbon_cluster
* nutanix_karbon_clusters
* nutanix_karbon_private_registries
* nutanix_karbon_private_registry
* nutanix_network_security_rule
* nutanix_permission
* nutanix_permissions
* nutanix_project
* nutanix_projects
* nutanix_role
* nutanix_roles
* nutanix_subnet
* nutanix_subnets
* nutanix_user_group
* nutanix_user_groups
* nutanix_user
* nutanix_users
* nutanix_virtual_machine
* nutanix_protection_rule
* nutanix_protection_rules
* nutanix_recovery_plan
* nutanix_recovery_plans


## Quick Install
Expand Down
7 changes: 3 additions & 4 deletions website/docs/d/hosts.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,22 @@ description: |-
Describes a list of hosts
---

# nutanix_host
# nutanix_hosts

Describes a list of hosts

## Example Usage

```hcl
data "nutanix_hosts" "host" {
}`
data "nutanix_hosts" "host" {}`
```

## Attribute Reference

The following attributes are exported:

* `api_version`: version of the API
* `entities`: List of Projects
* `entities`: List of Hosts

# Entities

Expand Down
44 changes: 44 additions & 0 deletions website/docs/d/karbon_cluster_kubeconfig.html.markdown
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/).
43 changes: 43 additions & 0 deletions website/docs/d/karbon_cluster_ssh.html.markdown
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/).
1 change: 0 additions & 1 deletion website/docs/d/network_security_rule.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ The following arguments are supported:

The following attributes are exported:

The following arguments are supported:
* `network_security_rule_id` - (Required) The ID for the rule you want to retrieve.
* `name`: - The name for the network_security_rule.
* `categories`: Categories for the network_security_rule.
Expand Down
86 changes: 86 additions & 0 deletions website/docs/d/permission.html.markdown
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/).
73 changes: 73 additions & 0 deletions website/docs/d/permissions.html.markdown
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/).
4 changes: 2 additions & 2 deletions website/docs/d/role.html.markdown
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
layout: "nutanix"
page_title: "NUTANIX: nutanix_role"
sidebar_current: "docs-nutanix-resource-role"
sidebar_current: "docs-nutanix-datasource-role"
description: |-
Describes a Role
This operation retrieves a role on the input parameters.
---

# nutanix_role
Expand Down
Loading

0 comments on commit 8576511

Please sign in to comment.