Merge pull request #388 from shapeblue/update-documentation

Update documentation for v0.5.0

Author: k8s-ci-robot

docs/book/src/clustercloudstack/configuration.md

@@ -145,6 +145,21 @@ cmk list templates zoneid=<zone-id> templatefilter=executable | jq '.template[]
 
 # Optional Configurations
 
+## Integration with CloudStack CKS
+
+CAPC cluster can be integrated with CloudStack CKS to provide a comprehensive view of the cluster resources on CloudStack.
+The integration can be enabled by setting the `CLOUDSTACK_SYNC_WITH_ACS` environment variable to `true` before
+generating the cluster or by setting CloudStackCluster.spec.syncWithACS to `true` in the cluster definition yaml.
+
+## Project
+
+CAPC cluster can be deployed within a specific project in CloudStack.
+The project name can be specified by adding the `CloudStackCluster.spec.project` field in the yaml specification.
+
+The list of projects can be fetched using the cmk cli as follows :
+```
+cmk list projects listall=true | jq '.project[] | {name, id}'
+
 ## Cluster Level Configurations
 
 These configurations are passed while defining the `CloudStackCluster` and apply to the entire cluster.

docs/book/src/getting-started.md

@@ -49,12 +49,12 @@
 
 Run the following command to turn your cluster into a management cluster and load the Apache CloudStack components into it.
 
-    clusterctl init --infrastructure cloudstack
+    CAPC_CLOUDSTACKMACHINE_CKS_SYNC=true clusterctl init --infrastructure cloudstack
 
-> If you wish to enable syncing of CAPC resources with cloudstack, set the environment variable
-> `CAPC_CLOUDSTACKMACHINE_CKS_SYNC=true` before initializing the cloudstack provider. Or set
-> `enable-cloudstack-cks-sync` to true in the deployment for capc-controller.
-> This is only supported for Apache CloudStack version 4.19 and above.
+> Integration of CAPC with CKS is supported for Apache CloudStack version 4.19 and above.
+> If you wish to disable syncing of CAPC resources with cloudstack, set the environment variable
+> `CAPC_CLOUDSTACKMACHINE_CKS_SYNC=false` before initializing the cloudstack provider. Or set
+> `enable-cloudstack-cks-sync` to `false` in the deployment spec for capc-controller-manager.
 
 <!-- References -->
 

docs/book/src/topics/index.md

@@ -9,7 +9,6 @@
 
 
 ## TODO :
-- Registering External Clusters in CloudStack
 - Data Disks
 - Diff between CKS and CAPC
 - E2E Tests