Skip to content

docs: update openstack credential examples #789

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

Open
zerospiel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update openstack credential examples #789

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
35 changes: 30 additions & 5 deletions docs/admin/installation/prepare-mgmt-cluster/openstack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

2. OpenStack CLI (optional)

If you plan to access OpenStack directly, go ahead and
If you plan to access OpenStack directly, go ahead and
[install the OpenStack CLI](https://docs.openstack.org/newton/user-guide/common/cli-install-openstack-command-line-clients.html).

3. Configure the OpenStack Application Credential
Expand Down Expand Up @@ -55,7 +55,7 @@
```

> NOTE:
> The name of the `Secret` must follow a specific pattern. See [credential secret](../../../appendix/appendix-providers.md#credential-secret) for details.
> The name of the `Secret` must follow a specific pattern. See [credential secret](../../../appendix/appendix-providers.md#credential-secret) for details.

Apply the YAML to your cluster:

Expand Down Expand Up @@ -91,7 +91,7 @@
kubectl apply -f openstack-cluster-identity-cred.yaml
```

Note that `.spec.identityRef.name` must match the `Secret` you created in the previous step, and
Note that `.spec.identityRef.name` must match the `Secret` you created in the previous step, and
`.spec.identityRef.namespace` must be the same as the one that includes the `Secret` (`kcm-system`).

6. Create the ConfigMap resource-template object
Expand Down Expand Up @@ -135,6 +135,9 @@

{{- $network_id := $cluster.status.externalNetwork.id -}}
{{- $network_name := $cluster.status.externalNetwork.name -}}

{{- $verify := index $openstack "verify" -}}
{{- $ca_cert := index $identity "data" "cacert" -}}
---
apiVersion: v1
kind: Secret
Expand Down Expand Up @@ -165,6 +168,14 @@
{{- end }}
region="{{ index $openstack "region_name" }}"

{{- if or (eq $verify false) (eq (lower (printf "%v" $verify)) "false") }}
tls-insecure=true
{{- end }}

{{- if $ca_cert }}
ca-file=/etc/cacert/ca.crt
{{- end }}

[LoadBalancer]
{{- if $network_id }}
floating-network-id="{{ $network_id }}"
Expand All @@ -174,8 +185,19 @@
{{- if $network_name }}
public-network-name="{{ $network_name }}"
{{- end }}
{{- if $ca_cert }}
---
apiVersion: v1
kind: Secret
metadata:
name: openstack-ca-cert
namespace: kube-system
type: Opaque
data:
ca.crt: "{{ $ca_cert }}"
{{- end }}
```

Apply the YAML to your cluster:

```bash
Expand All @@ -190,6 +212,7 @@
```bash
kubectl get clustertemplate -n kcm-system
```

```console { .no-copy }
NAME VALID
adopted-cluster-{{{ extra.docsVersionInfo.k0rdentVersion }}} true
Expand Down Expand Up @@ -273,14 +296,16 @@
```bash
kubectl get clusterdeployments -A
```

```console { .no-copy }
NAMESPACE NAME READY STATUS
kcm-system my-openstack-cluster-deployment True ClusterDeployment is ready
```

```bash
kubectl delete clusterdeployments my-openstack-cluster-deployment -n kcm-system
```

```console { .no-copy }
clusterdeployment.k0rdent.mirantis.com "my-openstack-cluster-deployment" deleted
```

39 changes: 36 additions & 3 deletions docs/quickstarts/quickstart-2-openstack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,21 +313,29 @@ data:
configmap.yaml: |
{{- $cluster := .InfrastructureProvider -}}
{{- $identity := (getResource "InfrastructureProviderIdentity") -}}

{{- $clouds := fromYaml (index $identity "data" "clouds.yaml" | b64dec) -}}
{{- if not $clouds }}
{{ fail "failed to decode clouds.yaml" }}
{{ end -}}

{{- $openstack := index $clouds "clouds" "openstack" -}}

{{- if not (hasKey $openstack "auth") }}
{{ fail "auth key not found in openstack config" }}
{{- end }}
{{- $auth := index $openstack "auth" -}}

{{- $auth_url := index $auth "auth_url" -}}
{{- $app_cred_id := index $auth "application_credential_id" -}}
{{- $app_cred_name := index $auth "application_credential_name" -}}
{{- $app_cred_secret := index $auth "application_credential_secret" -}}

{{- $network_id := $cluster.status.externalNetwork.id -}}
{{- $network_name := $cluster.status.externalNetwork.name -}}

{{- $verify := index $openstack "verify" -}}
{{- $ca_cert := index $identity "data" "cacert" -}}
---
apiVersion: v1
kind: Secret
Expand All @@ -339,28 +347,53 @@ data:
cloud.conf: |
[Global]
auth-url="{{ $auth_url }}"

{{- if $app_cred_id }}
application-credential-id="{{ $app_cred_id }}"
{{- end }}

{{- if $app_cred_name }}
application-credential-name="{{ $app_cred_name }}"
{{- end }}

{{- if $app_cred_secret }}
application-credential-secret="{{ $app_cred_secret }}"
{{- end }}

{{- if and (not $app_cred_id) (not $app_cred_secret) }}
username="{{ index $openstack "username" }}"
password="{{ index $openstack "password" }}"
{{- end }}
region="{{ index $openstack "region_name" }}"

{{- if or (eq $verify false) (eq (lower (printf "%v" $verify)) "false") }}
tls-insecure=true
{{- end }}

{{- if $ca_cert }}
ca-file=/etc/cacert/ca.crt
{{- end }}

[LoadBalancer]
{{- if $network_id }}
floating-network-id="{{ $network_id }}"
{{- end }}

[Networking]
{{- if $network_name }}
public-network-name="{{ $network_name }}"
{{- end }}
{{- if $ca_cert }}
---
apiVersion: v1
kind: Secret
metadata:
name: openstack-ca-cert
namespace: kube-system
type: Opaque
data:
ca.crt: "{{ $ca_cert }}"
{{- end }}
```

Apply the YAML to your cluster:
Expand Down Expand Up @@ -537,9 +570,9 @@ Now that you've finished the {{{ docsVersionInfo.k0rdentName }}} QuickStart, we

Check out the [Administrator Guide](../admin/index.md) ...

* For a more detailed view of {{{ docsVersionInfo.k0rdentName }}} setup for production
* For details about setting up {{{ docsVersionInfo.k0rdentName }}} to manage clusters on VMware
* For details about using {{{ docsVersionInfo.k0rdentName }}} with cloud Kubernetes distros such as AWS EKS, Azure AKS, and Google Kubernetes Engine
- For a more detailed view of {{{ docsVersionInfo.k0rdentName }}} setup for production
- For details about setting up {{{ docsVersionInfo.k0rdentName }}} to manage clusters on VMware
- For details about using {{{ docsVersionInfo.k0rdentName }}} with cloud Kubernetes distros such as AWS EKS, Azure AKS, and Google Kubernetes Engine

<!--
Or check out the [Demos Repository](https://github.com/k0rdent/demos) for fast, makefile-driven demos of {{{ docsVersionInfo.k0rdentName }}}'s key features.
Expand Down