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 OpenStack template #96

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update OpenStack template #96

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b23b5c
Update OpenStack template
wkonitzer Jan 23, 2025
eec9854
Update OpenStack template-parameters.md
wkonitzer Jan 27, 2025
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
56 changes: 46 additions & 10 deletions docs/clustertemplates/openstack/template-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,50 @@

## ClusterDeployment Parameters

To deploy an OpenStack cluster, the following parameters are critical in the `ClusterDeployment` resource:

| Parameter | Example | Description |
|-------------------------------|---------------------------------------|-----------------------------------------------------|
| `.spec.credential` | `openstack-cluster-identity-cred` | Reference to the Credential object. |
| `.spec.template` | `openstack-standalone-cp-0-0-1` | Reference to the ClusterTemplate. |
| `.spec.config.authURL` | `https://keystone.yourorg.net/` | Keystone authentication endpoint for OpenStack. |
| `.spec.config.controlPlaneNumber` | `3` | Number of control plane nodes. |
| `.spec.config.workersNumber` | `2` | Number of worker nodes. |
To deploy an OpenStack cluster, the following are the primary parameters in the `ClusterDeployment` resource:

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Example</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>.spec.credential</td>
<td><code>openstack-cluster-identity-cred</code></td>
<td>Reference to the Credential object.</td>
</tr>
<tr>
<td>.spec.template</td>
<td><code>openstack-standalone-cp-0-0-1</code></td>
<td>Reference to the ClusterTemplate.</td>
</tr>
<tr>
<td>.spec.config.authURL</td>
<td><code>https://keystone.yourorg.net/</code></td>
<td>Keystone authentication endpoint for OpenStack.</td>
</tr>
<tr>
<td>.spec.config.controlPlaneNumber</td>
<td><code>3</code></td>
<td>Number of control plane nodes.</td>
</tr>
<tr>
<td>.spec.config.workersNumber</td>
<td><code>2</code></td>
<td>Number of worker nodes.</td>
</tr>
<tr>
<td>.spec.config.clusterLabels<br>(optional)</td>
<td><code>k0rdent: demo</code></td>
<td>Labels to apply to the cluster. Used by <br>MultiClusterService.</td>
</tr>
</tbody>
</table>

### SSH Configuration

`sshPublicKey` is a reference name for an existing SSH key configured in OpenStack.
Expand All @@ -29,7 +63,7 @@ Configurations for control plane and worker nodes are specified separately under
| `sshPublicKey` | `ramesses-pk` | Reference name for an existing SSH key.|
| `securityGroups.filter.name`| `default` | Security group for the instance. |

> [!NOTE]
> NOTE:
> Ensure `.spec.credential` references the `Credential` object (see [OpenStack-QuickStart](../../quick-start/openstack.md))
> The recommended minimum vCPU value for the control plane flavor is 2, while for the worker node flavor, it is 1. For detailed information, refer to the [machine-flavor CAPI docs](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/docs/book/src/clusteropenstack/configuration.md#machine-flavor).

Expand All @@ -45,6 +79,8 @@ spec:
template: openstack-standalone-cp-0-0-2
credential: openstack-cluster-identity-cred
config:
clusterLabels:
k0rdent: demo
controlPlaneNumber: 1
workersNumber: 1
controlPlane:
Expand Down