Skip to content
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.

Sign up for GitHub

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

Update documentation for v0.5.0 #388

Merged
merged 1 commit into from
Jul 5, 2024
Merged

Update documentation for v0.5.0 #388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/book/src/clustercloudstack/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
10 changes: 5 additions & 5 deletions docs/book/src/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->

Expand Down
1 change: 0 additions & 1 deletion docs/book/src/topics/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@


## TODO :
- Registering External Clusters in CloudStack
- Data Disks
- Diff between CKS and CAPC
- E2E Tests