Skip to content

Commit

Permalink
docs: made changes suggested by yannick and gaby
Browse files Browse the repository at this point in the history
  • Loading branch information
Edgar López committed Dec 21, 2020
1 parent 7f9e094 commit 17df2b2
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 52 deletions.
28 changes: 14 additions & 14 deletions website/docs/d/karbon_cluster.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ The following arguments are supported:
The following arguments are supported:

* `name`: - The name for the k8s cluster.
* `wait_timeout_minutes`
* `wait_timeout_minutes`: - Maximum wait time for the Karbon cluster to provision.
* `version`: - K8s version of the cluster.
* `storage_class_config`
* `storage_class_config`: - Storage class configuration attribute for defining the persistent volume attributes.
* `single_master_config`: - Configuration of a single master node.
* `active_passive_config`: - The active passive mode uses the Virtual Router Redundancy Protocol (VRRP) protocol to provide high availability of the master.
* `external_lb_config`: - The external load balancer configuration in the case of a multi-master-external-load-balancer type master deployment.
* `private_registry`: - .
* `private_registry`: - Allows the Karbon cluster to pull images of a list of private registries.
* `etcd_node_pool`: - Configuration of the node pools that the nodes in the etcd cluster belong to. The etcd nodes require a minimum of 8,192 MiB memory and 409,60 MiB disk space.
* `master_node_pool`: - .
* `master_node_pool`: - Configuration of the master node pools.
* `cni_config`: - K8s cluster networking configuration. The flannel or the calico configuration needs to be provided.

### Storage Class Config
Expand All @@ -48,11 +48,11 @@ The storage_class_config attribute supports the following:
* `name`: - The name of the storage class.
* `reclaim_policy` - Reclaim policy for persistent volumes provisioned using the specified storage class.
* `volumes_config.#.file_system` - Karbon uses either the ext4 or xfs file-system on the volume disk.
* `volumes_config.#.flash_mode`
* `volumes_config.#.password` - TPassword of the Prism Element user that the API calls use to provision volumes.
* `volumes_config.#.flash_mode` - Pins the persistent volumes to the flash tier in case of a `true` value.
* `volumes_config.#.password` - The password of the Prism Element user that the API calls use to provision volumes.
* `volumes_config.#.prism_element_cluster_uuid` - The universally unique identifier (UUID) of the Prism Element cluster.
* `volumes_config.#.storage_container` - TName of the storage container the storage container uses to provision volumes.
* `volumes_config.#.username` - TThe username of the Prism Element user that the API calls use to provision volumes.
* `volumes_config.#.storage_container` - Name of the storage container the storage container uses to provision volumes.
* `volumes_config.#.username` - Username of the Prism Element user that the API calls use to provision volumes.


### External LB Config
Expand All @@ -67,8 +67,8 @@ The external load balancer configuration in the case of a multi-master-external-
### private_registry
User inputs of storage configuration parameters for VMs.

* `private_registry`: - .
* `private_registry.registry_name`: - .
* `private_registry`: - List of private registries.
* `private_registry.registry_name`: - Name of the private registry to add to the Karbon cluster.

### Node Pool

Expand All @@ -77,15 +77,15 @@ The `etcd_node_pool`, `master_node_pool`, `worker_node_pool` attribute supports
* `name`: - Unique name of the node pool.
* `node_os_version`: - The version of the node OS image.
* `num_instances`: - Number of nodes in the node pool.
* `ahv_config`: - .
* `ahv_config`: - VM configuration in AHV.
* `ahv_config.cpu`: - The number of VCPUs allocated for each VM on the PE cluster.
* `ahv_config.disk_mib`: - Size of local storage for each VM on the PE cluster in MiB.
* `ahv_config.memory_mib`: - Memory allocated for each VM on the PE cluster in MiB.
* `ahv_config.network_uuid`: - The UUID of the network for the VMs deployed with this resource configuration.
* `ahv_config.prism_element_cluster_uuid`: - The unique universal identifier (UUID) of the Prism Element cluster used to deploy VMs for this node pool.
* `nodes`
* `nodes.hostname`
* `nodes.ipv4_address`
* `nodes`: - List of the deployed nodes in the node pool.
* `nodes.hostname`: - Hostname of the deployed node.
* `nodes.ipv4_address`: - IP of the deployed node.

### cni_config

Expand Down
62 changes: 24 additions & 38 deletions website/docs/r/karbon_cluster.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ resource "nutanix_karbon_cluster" "vm1" {
The following arguments are supported:

* `name`: - (Required) The name for the k8s cluster.
* `wait_timeout_minutes`: - (Optional) .
* `version`: - (Optional) K8s version of the cluster.
* `storage_class_config`: - (Required)
* `wait_timeout_minutes`: - (Optional) Maximum wait time for the Karbon cluster to provision.
* `version`: - (Required) K8s version of the cluster.
* `storage_class_config`: - (Required) Storage class configuration attribute for defining the persistent volume attributes.
* `single_master_config`: - (Optional) Configuration of a single master node.
* `active_passive_config`: - (Optional) The active passive mode uses the Virtual Router Redundancy Protocol (VRRP) protocol to provide high availability of the master.
* `external_lb_config`: - (Optional) The external load balancer configuration in the case of a multi-master-external-load-balancer type master deployment.
* `private_registry`: - (Optional) .
* `etcd_node_pool`: - (Optional) Configuration of the node pools that the nodes in the etcd cluster belong to. The etcd nodes require a minimum of 8,192 MiB memory and 409,60 MiB disk space.
* `master_node_pool`: - (Optional) .
* `private_registry`: - (Optional) Allows the Karbon cluster to pull images of a list of private registries.
* `etcd_node_pool`: - (Required) Configuration of the node pools that the nodes in the etcd cluster belong to. The etcd nodes require a minimum of 8,192 MiB memory and 409,60 MiB disk space.
* `master_node_pool`: - (Required) Configuration of the master node pools.
* `cni_config`: - (Required) K8s cluster networking configuration. The flannel or the calico configuration needs to be provided.

### Storage Class Config
Expand All @@ -42,12 +42,12 @@ The storage_class_config attribute supports the following:

* `name`: - (Required) The name of the storage class.
* `reclaim_policy` - (Optional) Reclaim policy for persistent volumes provisioned using the specified storage class.
* `volumes_config.#.file_system` - Karbon uses either the ext4 or xfs file-system on the volume disk.
* `volumes_config.#.flash_mode`
* `volumes_config.#.password` - (Required) TPassword of the Prism Element user that the API calls use to provision volumes.
* `volumes_config.#.prism_element_cluster_uuid` - The universally unique identifier (UUID) of the Prism Element cluster.
* `volumes_config.#.storage_container` - (Required) TName of the storage container the storage container uses to provision volumes.
* `volumes_config.#.username` - (Required) TThe username of the Prism Element user that the API calls use to provision volumes.
* `volumes_config.#.file_system` - (Optional) Karbon uses either the ext4 or xfs file-system on the volume disk.
* `volumes_config.#.flash_mode` - (Optional) Pins the persistent volumes to the flash tier in case of a `true` value.
* `volumes_config.#.password` - (Required) The password of the Prism Element user that the API calls use to provision volumes.
* `volumes_config.#.prism_element_cluster_uuid` - (Required) The universally unique identifier (UUID) of the Prism Element cluster.
* `volumes_config.#.storage_container` - (Required) Name of the storage container the storage container uses to provision volumes.
* `volumes_config.#.username` - (Required) Username of the Prism Element user that the API calls use to provision volumes.


### External LB Config
Expand All @@ -57,30 +57,30 @@ The external load balancer configuration in the case of a multi-master-external-
* `external_lb_config.#.external_ipv4_address`: (Required) The external load balancer IPV4 address.
* `external_lb_config.#.master_nodes_config`: (Required) The configuration of the master nodes.
* `external_lb_config.#.master_nodes_config.ipv4_address`: (Required) The IPV4 address to assign to the master.
* `external_lb_config.#.master_nodes_config.node_pool_name`: (Required) The name of the node pool in which this master IPV4 address will be used.
* `external_lb_config.#.master_nodes_config.node_pool_name`: (Optional) The name of the node pool in which this master IPV4 address will be used.

### private_registry
User inputs of storage configuration parameters for VMs.

* `private_registry`: - .
* `private_registry.registry_name`: - .
* `private_registry`: - (Optional) List of private registries.
* `private_registry.registry_name`: - (Required) Name of the private registry to add to the Karbon cluster.

### Node Pool

The `etcd_node_pool`, `master_node_pool`, `worker_node_pool` attribute supports the following:

* `name`: - (Required) Unique name of the node pool.
* `name`: - (Optional) Unique name of the node pool.
* `node_os_version`: - (Required) The version of the node OS image.
* `num_instances`: - (Required) Number of nodes in the node pool.
* `ahv_config`: - (Optional) .
* `ahv_config`: - (Optional) VM configuration in AHV.
* `ahv_config.cpu`: - (Required) The number of VCPUs allocated for each VM on the PE cluster.
* `ahv_config.disk_mib`: - (Required) Size of local storage for each VM on the PE cluster in MiB.
* `ahv_config.memory_mib`: - (Required) Memory allocated for each VM on the PE cluster in MiB.
* `ahv_config.network_uuid`: - (Optional) The UUID of the network for the VMs deployed with this resource configuration.
* `ahv_config.prism_element_cluster_uuid`: - (Optional) The unique universal identifier (UUID) of the Prism Element cluster used to deploy VMs for this node pool.
* `nodes`
* `nodes.hostname`
* `nodes.ipv4_address`
* `ahv_config.disk_mib`: - (Optional) Size of local storage for each VM on the PE cluster in MiB.
* `ahv_config.memory_mib`: - (Optional) Memory allocated for each VM on the PE cluster in MiB.
* `ahv_config.network_uuid`: - (Required) The UUID of the network for the VMs deployed with this resource configuration.
* `ahv_config.prism_element_cluster_uuid`: - (Required) The unique universal identifier (UUID) of the Prism Element cluster used to deploy VMs for this node pool.
* `nodes`: - List of the deployed nodes in the node pool.
* `nodes.hostname`: - Hostname of the deployed node.
* `nodes.ipv4_address`: - IP of the deployed node.

### cni_config

Expand All @@ -94,18 +94,4 @@ The `etcd_node_pool`, `master_node_pool`, `worker_node_pool` attribute supports
* `calico_config.ip_pool_config`: - (Optional) List of IP pools to be configured/managed by calico.
* `calico_config.ip_pool_config.cidr`: - (Optional) IP range to use for this pool, it should fall within pod cidr.


## Attributes Reference

The following attributes are exported:

* `metadata`: - .
* `version` - K8s version of the cluster.

### Metadata

The metadata attribute exports the following:

* `api_version`: - Karbon API version.

See detailed information in [Nutanix Karbon Cluster](https://www.nutanix.dev/reference/karbon/api-reference/cluster/).

2 comments on commit 17df2b2

@gabybeitler
Copy link
Contributor

@gabybeitler gabybeitler commented on 17df2b2 Jan 5, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@marinsalinas @yannickstruyf3 We still need to have optional and required notations in the website/docs/d/karbon_cluster.html.markdown section. Once that is complete we can merge.

@gabybeitler
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per conversation with @yannickstruyf3 the values not marked either optional or required cannot be set by user, since that is the case, I think we can merge.

Please sign in to comment.