diff --git a/docs/openstack-horizon.md b/docs/openstack-horizon.md index 6672744c..4156c5e0 100644 --- a/docs/openstack-horizon.md +++ b/docs/openstack-horizon.md @@ -2,21 +2,86 @@ [![asciicast](https://asciinema.org/a/629815.svg)](https://asciinema.org/a/629815) -## Create secrets +## Pre-requsites + +- Vault should be installed by following the instructions in [vault documentation](https://docs.rackspacecloud.com/vault/) +- User has access to `osh/horizon/` path in the Vault + +## Create secrets in the vault + +### Login to the vault + +``` shell +kubectl exec -it vault-0 -n vault -- \ + vault login -method userpass username=horizon +``` + +### List the existing secrets from `osh/horizon/` + +``` shell +kubectl exec --stdin=true --tty=true vault-0 -n vault -- \ + vault kv list osh/horizon +``` + +### Create the secrets + +- Horizon-secrete-key Username and Password: + +``` shell +kubectl exec --stdin=true --tty=true vault-0 -n vault -- \ + vault kv put osh/horizon/horizon-secrete-key username=horizon + +kubectl exec --stdin=true --tty=true vault-0 -n vault -- \ + vault kv patch -mount=osh/horizon horizon-secrete-key \ + password=$(< /dev/urandom tr -dc _A-Za-z0-9 | head -c${1:-64};echo;) +``` + +- Horizon Database Password: + +``` shell +kubectl exec --stdin=true --tty=true vault-0 -n vault -- \ + vault kv put -mount=osh/horizon horizon-db-password \ + password=$(< /dev/urandom tr -dc _A-Za-z0-9 | head -c${1:-32};echo;) +``` + +### Validate the secrets + +``` shell +kubectl exec --stdin=true --tty=true vault-0 -n vault -- \ + vault kv list osh/horizon +kubectl exec --stdin=true --tty=true vault-0 -n vault -- \ + vault kv get -mount=osh/horizon horizon-secrete-key +``` + +## Install Horizon + +- Ensure that the `vault-ca-secret` Kubernetes Secret exists in the OpenStack namespace containing the Vault CA certificate: + +```shell +kubectl get secret vault-ca-secret -o yaml -n openstack +``` + +- If it is absent, create one using the following command: + +``` shell +kubectl create secret generic vault-ca-secret \ + --from-literal=ca.crt="$(kubectl get secret vault-tls-secret \ + -o jsonpath='{.data.ca\.crt}' -n vault | base64 -d -)" -n openstack +``` + +- Deploy the necessary Vault resources to create Kubernetes secrets required by the Horizon installation: + +``` shell +kubectl apply -k /opt/genestack/kustomize/horizon/base/vault/ +``` + +- Validate whether the required Kubernetes secrets from Vault are populated: ``` shell -kubectl --namespace openstack \ - create secret generic horizon-secrete-key \ - --type Opaque \ - --from-literal=username="horizon" \ - --from-literal=password="$(< /dev/urandom tr -dc _A-Za-z0-9 | head -c${1:-64};echo;)" -kubectl --namespace openstack \ - create secret generic horizon-db-password \ - --type Opaque \ - --from-literal=password="$(< /dev/urandom tr -dc _A-Za-z0-9 | head -c${1:-32};echo;)" +kubectl get secrets -n openstack ``` -## Run the package deployment +### Deploy Horizon helm chart ``` shell cd /opt/genestack/submodules/openstack-helm diff --git a/kustomize/horizon/base/vault/horizon-db-password.yaml b/kustomize/horizon/base/vault/horizon-db-password.yaml new file mode 100644 index 00000000..14dedb24 --- /dev/null +++ b/kustomize/horizon/base/vault/horizon-db-password.yaml @@ -0,0 +1,24 @@ +apiVersion: secrets.hashicorp.com/v1beta1 +kind: VaultStaticSecret +metadata: + name: horizon-db-password + namespace: openstack +spec: + type: kv-v2 + + # mount path + mount: 'osh/horizon' + + # path of the secret + path: horizon-db-password + + # dest k8s secret + destination: + name: horizon-db-password + create: true + + # static secret refresh interval + refreshAfter: 30s + + # Name of the CRD to authenticate to Vault + vaultAuthRef: vault-auth diff --git a/kustomize/horizon/base/vault/horizon-secrete-key.yaml b/kustomize/horizon/base/vault/horizon-secrete-key.yaml new file mode 100644 index 00000000..60c52a48 --- /dev/null +++ b/kustomize/horizon/base/vault/horizon-secrete-key.yaml @@ -0,0 +1,24 @@ +apiVersion: secrets.hashicorp.com/v1beta1 +kind: VaultStaticSecret +metadata: + name: horizon-secrete-key + namespace: openstack +spec: + type: kv-v2 + + # mount path + mount: 'osh/horizon' + + # path of the secret + path: horizon-secrete-key + + # dest k8s secret + destination: + name: horizon-secrete-key + create: true + + # static secret refresh interval + refreshAfter: 30s + + # Name of the CRD to authenticate to Vault + vaultAuthRef: vault-auth diff --git a/kustomize/horizon/base/vault/kustomization.yaml b/kustomize/horizon/base/vault/kustomization.yaml new file mode 100644 index 00000000..83a19417 --- /dev/null +++ b/kustomize/horizon/base/vault/kustomization.yaml @@ -0,0 +1,6 @@ +namespace: openstack +resources: + - vaultauth.yaml + - vaultconnection.yaml + - horizon-db-password.yaml + - horizon-secrete-key.yaml diff --git a/kustomize/horizon/base/vault/vaultauth.yaml b/kustomize/horizon/base/vault/vaultauth.yaml new file mode 100644 index 00000000..a4f6a50a --- /dev/null +++ b/kustomize/horizon/base/vault/vaultauth.yaml @@ -0,0 +1,14 @@ +apiVersion: secrets.hashicorp.com/v1beta1 +kind: VaultAuth +metadata: + name: vault-auth + namespace: openstack +spec: + method: kubernetes + mount: genestack + kubernetes: + role: osh + serviceAccount: default + audiences: + - vault + vaultConnectionRef: vault-connection diff --git a/kustomize/horizon/base/vault/vaultconnection.yaml b/kustomize/horizon/base/vault/vaultconnection.yaml new file mode 100644 index 00000000..61e878fd --- /dev/null +++ b/kustomize/horizon/base/vault/vaultconnection.yaml @@ -0,0 +1,18 @@ +apiVersion: secrets.hashicorp.com/v1beta1 +kind: VaultConnection +metadata: + namespace: openstack + name: vault-connection +spec: + # required configuration + # address to the Vault server. + address: https://vault.vault.svc.cluster.local:8200 + # optional configuration + # HTTP headers to be included in all Vault requests. + # headers: [] + # TLS server name to use as the SNI host for TLS connections. + # tlsServerName: "" + # skip TLS verification for TLS connections to Vault. + skipTLSVerify: false + # the trusted PEM encoded CA certificate chain stored in a Kubernetes Secret + caCertSecretRef: "vault-ca-secret"