-
Notifications
You must be signed in to change notification settings - Fork 116
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Karbon docs #221
Karbon docs #221
Conversation
@yannickstruyf3 can you take a look? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added some remarks with regards to the documentation. Please review the comments and apply them to the rest of the Karbon documentation files.
Thanks
* `external_lb_config`: - The external load balancer configuration in the case of a multi-master-external-load-balancer type master deployment. | ||
* `private_registry`: - . | ||
* `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`: - . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
master_node_pool
: - Configuration of the master node pools.
* `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` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pins the persistent volumes to the flash tier in case of a true
value.
* `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`: - . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
VM configuration in AHV
* `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` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
List of the deployed nodes in the node pool
* `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` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hostname of the deployed node
* `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` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IP of the deployed node
|
||
* `name`: - (Required) The name for the k8s cluster. | ||
* `wait_timeout_minutes`: - (Optional) . | ||
* `version`: - (Optional) K8s version of the cluster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not optional?
@yannickstruyf3 @gabybeitler can you give a second review? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! just we need the approval from Nutanix (@gabybeitler or @yannickstruyf3 )
Added docs for resource and datasource(s):