Skip to content

Commit b514380

Browse files
committed
docs: update skyline docs for cleaner info and refactor code
1 parent 5afb1ef commit b514380

File tree

2 files changed

+11
-46
lines changed

2 files changed

+11
-46
lines changed

bin/create-skyline-secrets.sh

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -104,38 +104,12 @@ if grep -q "name: skyline-apiserver-secrets" ${OUTPUT_FILE}; then
104104
fi
105105

106106
# Append to kubesecrets.yaml
107-
cat <<EOF >> $OUTPUT_FILE
108-
---
109-
apiVersion: v1
110-
kind: Secret
111-
metadata:
112-
name: skyline-apiserver-secrets
113-
namespace: openstack
114-
type: Opaque
115-
data:
116-
service-username: $(echo -n "skyline" | base64)
117-
service-password: $(echo -n $skyline_service_password | base64 -w0)
118-
service-domain: $(echo -n "service" | base64)
119-
service-project: $(echo -n "service" | base64)
120-
service-project-domain: $(echo -n "service" | base64)
121-
db-endpoint: $(echo -n "mariadb-cluster-primary.openstack.svc.cluster.local" | base64 -w0)
122-
db-name: $(echo -n "skyline" | base64)
123-
db-username: $(echo -n "skyline" | base64)
124-
db-password: $(echo -n $skyline_db_password | base64 -w0)
125-
secret-key: $(echo -n $skyline_secret_key_password | base64 -w0)
126-
keystone-endpoint: $(echo -n "http://keystone-api.openstack.svc.cluster.local:5000/v3" | base64 -w0)
127-
keystone-username: $(echo -n "skyline" | base64)
128-
default-region: $(echo -n "$region" | base64)
129-
prometheus_basic_auth_password: $(echo -n "" | base64)
130-
prometheus_basic_auth_user: $(echo -n "" | base64)
131-
prometheus_enable_basic_auth: $(echo -n "false" | base64)
132-
prometheus_endpoint: $(echo -n "http://kube-prometheus-stack-prometheus.prometheus.svc.cluster.local:9090" | base64 -w0)
133-
EOF
107+
echo "$SKYLINE_SECRET_CONTENT" >> $OUTPUT_FILE
134108

135-
echo "Skyline secrets appended to ${OUTPUT_FILE}"
109+
echo "Skyline secret appended to ${OUTPUT_FILE}"
136110
echo ""
137111
echo "✓ Successfully created ${SKYLINE_SECRETS_FILE}"
138-
echo "✓ Successfully appended skyline secrets to ${OUTPUT_FILE}"
112+
echo "✓ Successfully appended skyline secret to ${OUTPUT_FILE}"
139113
echo ""
140114
echo "IMPORTANT: Keep ${SKYLINE_SECRETS_FILE} safe!"
141-
echo " It will be used to preserve skyline secrets when regenerating ${OUTPUT_FILE}"
115+
echo " It will be used to preserve skyline secret when regenerating ${OUTPUT_FILE}"

docs/openstack-skyline.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,7 @@ OpenStack Skyline is the next-generation web-based dashboard designed to provide
44

55
## Create secrets
66

7-
!!! note "Automated secret generation"
8-
9-
Skyline secrets can be generated automatically using the `create-skyline-secrets.sh` script located in `/opt/genestack/bin`. This script integrates with the main `create-secrets.sh` workflow and handles all secret generation automatically.
10-
11-
### Automated Secret Generation
12-
13-
The recommended approach is to use the automated script:
7+
Skyline secret can be generated using the `create-skyline-secrets.sh` script located in `/opt/genestack/bin`. This script integrates with the `create-secrets.sh` workflow and handles all secret generation.
148

159
``` shell
1610
# Generate Skyline secrets with default region (RegionOne)
@@ -19,23 +13,20 @@ The recommended approach is to use the automated script:
1913

2014
The script will:
2115

22-
- Generate secure random passwords for all Skyline services
23-
- Create `/etc/genestack/skylinesecrets.yaml` with the Skyline-specific secrets
24-
- Append the secrets to `/etc/genestack/kubesecrets.yaml` for integration with the main workflow
16+
- Generate secure random passwords for the Skyline service
17+
- Create `/etc/genestack/skylinesecrets.yaml` with the Skyline-specific secret
18+
- Append the secret to `/etc/genestack/kubesecrets.yaml` for integration with the main workflow
2519
- Perform safety checks to prevent duplicate secret generation
26-
- Ensure the main `kubesecrets.yaml` file exists before proceeding
20+
- Ensure the `kubesecrets.yaml` file exists before proceeding
2721

2822
!!! warning "Prerequisites"
2923

30-
The `create-skyline-secrets.sh` script requires that `/etc/genestack/kubesecrets.yaml` already exists. Run the main `create-secrets.sh` script first if you haven't already.
31-
32-
!!! note "Secret Management"
24+
The `create-skyline-secrets.sh` script requires that `/etc/genestack/kubesecrets.yaml` already exists. Run the `create-secrets.sh` script first if you haven't already.
3325

34-
All Skyline configuration is managed in a single secret object (`skyline-apiserver-secrets`), making deployment simpler compared to other OpenStack services that use Helm integration.
3526

3627
### Manual Secret Generation (Alternative)
3728

38-
If you prefer manual control or need to customize specific values, you can still create secrets manually:
29+
Manual secret generation is only required if you haven't run the `create-skyline-secrets.sh` script located in `/opt/genestack/bin`.
3930

4031
??? example "Manual secret generation"
4132

0 commit comments

Comments
 (0)