From 17fcc37023d5105f8ccdec2fc182be48b7a58fb9 Mon Sep 17 00:00:00 2001 From: Kevin Carter Date: Thu, 30 May 2024 10:40:41 -0500 Subject: [PATCH] Fix: update the docs flow for installs Signed-off-by: Kevin Carter --- docs/build-test-envs.md | 8 +++++--- ...kstart.md => genestack-getting-started.md} | 2 +- docs/index.md | 2 +- docs/infrastructure-ovn.md | 6 ------ docs/k8s-kubespray.md | 20 ------------------- docs/sealed-secrets.md | 5 ++++- docs/vault-secrets-operator.md | 4 ++++ docs/vault.md | 4 ++++ mkdocs.yml | 13 ++++++------ 9 files changed, 26 insertions(+), 38 deletions(-) rename docs/{quickstart.md => genestack-getting-started.md} (97%) delete mode 100644 docs/infrastructure-ovn.md diff --git a/docs/build-test-envs.md b/docs/build-test-envs.md index a00100af..1f948f31 100644 --- a/docs/build-test-envs.md +++ b/docs/build-test-envs.md @@ -1,8 +1,10 @@ # Lab Build Demo -[![asciicast](https://asciinema.org/a/629776.svg)](https://asciinema.org/a/629776) +!!! Example "This section is only for test environments" + + The information on this page is only needed when building an environment in Virtual Machines. -The information on this page is only needed when building an environment in Virtual Machines. +[![asciicast](https://asciinema.org/a/629776.svg)](https://asciinema.org/a/629776) ## Prerequisites @@ -12,7 +14,7 @@ Take a moment to orient yourself, there are a few items to consider before movin !!! note - Your local genestack repository will be transferred to the eventual launcher instance for convenience **perfect for development**. See [Getting Started](quickstart.md) for an example on how to recursively clone the repository and its submodules. + Your local genestack repository will be transferred to the eventual launcher instance for convenience **perfect for development**. See [Getting Started](genestack-getting-started.md) for an example on how to recursively clone the repository and its submodules. ### Create a VirtualEnv diff --git a/docs/quickstart.md b/docs/genestack-getting-started.md similarity index 97% rename from docs/quickstart.md rename to docs/genestack-getting-started.md index 359b3a4c..24abef62 100644 --- a/docs/quickstart.md +++ b/docs/genestack-getting-started.md @@ -1,4 +1,4 @@ -# Quick Start Guide +# Getting the Genestack Repository Before you can do anything we need to get the code. Because we've sold our soul to the submodule devil, you're going to need to recursively clone the repo into your location. diff --git a/docs/index.md b/docs/index.md index 18d80d8a..063333b3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -40,7 +40,7 @@ hide: Start building now. - [:octicons-play-24: Deployment Guide](quickstart.md) + [:octicons-play-24: Deployment Guide](genestack-getting-started.md) diff --git a/docs/infrastructure-ovn.md b/docs/infrastructure-ovn.md deleted file mode 100644 index 74371926..00000000 --- a/docs/infrastructure-ovn.md +++ /dev/null @@ -1,6 +0,0 @@ -# Deploy Open vSwitch OVN - -Note that we're not deploying Openvswitch, however, we are using it. The implementation on Genestack is assumed to be -done with Kubespray which deploys OVN as its networking solution. Because those components are handled by our infrastructure -there's nothing for us to manage / deploy in this environment. OpenStack will leverage OVN within Kubernetes following the -scaling/maintenance/management practices of kube-ovn. diff --git a/docs/k8s-kubespray.md b/docs/k8s-kubespray.md index 398fcdf9..16d26392 100644 --- a/docs/k8s-kubespray.md +++ b/docs/k8s-kubespray.md @@ -140,23 +140,3 @@ ansible-playbook --inventory /etc/genestack/inventory/openstack-flex-inventory.i Given the use of a venv, when running with `sudo` be sure to use the full path and pass through your environment variables; `sudo -E /home/ubuntu/.venvs/genestack/bin/ansible-playbook`. Once the cluster is online, you can run `kubectl` to interact with the environment. - -## Installing Kubernetes - -Currently only the k8s provider kubespray is supported and included as submodule into the code base. -A default inventory file for kubespray is provided at `/etc/genestack/inventory` and must be modified. - -!!! tip - - Existing OpenStack Ansible inventory can be converted using the `/opt/genestack/scripts/convert_osa_inventory.py` - script which provides a `hosts.yml` - -Once the inventory is updated and configuration altered (networking etc), the Kubernetes cluster can be initialized with -the `setup-kubernetes.yml` playbook which in addition will also label nodes for OpenStack installation. - -``` shell -source /opt/genestack/scripts/genestack.rc -cd /opt/genestack/ansible/playbooks - -ansible-playbook setup-kubernetes.yml -``` diff --git a/docs/sealed-secrets.md b/docs/sealed-secrets.md index e46d4dae..7c635cd9 100644 --- a/docs/sealed-secrets.md +++ b/docs/sealed-secrets.md @@ -1,5 +1,8 @@ -# Sealed Secrets Introduction and Installation Guide +!!! Danger "This section is still underdevelopment and experimental" + + None of the vault components are required to run a Genestack environment. +# Sealed Secrets Introduction and Installation Guide Sealed Secrets is a Kubernetes-native solution for securely storing and managing sensitive information within Kubernetes Secrets. It ensures secure secret management by encrypting Kubernetes Secrets and storing them as SealedSecret resources, which can only be decrypted by the cluster itself. diff --git a/docs/vault-secrets-operator.md b/docs/vault-secrets-operator.md index 43279f99..e9552211 100644 --- a/docs/vault-secrets-operator.md +++ b/docs/vault-secrets-operator.md @@ -1,3 +1,7 @@ +!!! Danger "This section is still underdevelopment and experimental" + + None of the vault components are required to run a Genestack environment. + # HashiCorp Vault Secret Operators for Genestack Installation The Vault Secrets Operator (VSO) enables Pods to seamlessly consume Vault secrets from Kubernetes Secrets. This guide outlines the process of consuming secrets stored in Vault for Genestack installation. This is continuation of [vault.md](https://docs.rackspacecloud.com/vault/) where we have created few secrets in the Vault diff --git a/docs/vault.md b/docs/vault.md index 8be0fbde..da46bc11 100644 --- a/docs/vault.md +++ b/docs/vault.md @@ -1,3 +1,7 @@ +!!! Danger "This section is still underdevelopment and experimental" + + None of the vault components are required to run a Genestack environment. + # HashiCorp Vault Setup for Genestack Installation HashiCorp Vault is a versatile tool designed for secret management and data protection. It allows you to securely store and control access to various sensitive data, such as tokens, passwords, certificates, and API keys. In this guide, we will use HashiCorp Vault to store Kubernetes Secrets for the Genestack installation. diff --git a/mkdocs.yml b/mkdocs.yml index 3f6942ef..3227ada6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -130,11 +130,11 @@ nav: - Overview: - Architecture: genestack-architecture.md - Components: genestack-components.md - - Quickstart: - - Building Virtual Environments: build-test-envs.md - - Simple Setup: quickstart.md - Deployment Guide: - What is Genestack?: deployment-guide-welcome.md + - Getting Started: + - Building Virtual Environments: build-test-envs.md + - Getting the code: genestack-getting-started.md - Open Infrastructure: - Kubernetes: - k8s-overview.md @@ -186,9 +186,9 @@ nav: - skyline: openstack-skyline.md - Octavia: openstack-octavia.md - Metering: - - PostgreSQL: infrastructure-postgresql.md - - Gnocchi: openstack-gnocchi.md - - Ceilometer: openstack-ceilometer.md + - PostgreSQL: infrastructure-postgresql.md + - Gnocchi: openstack-gnocchi.md + - Ceilometer: openstack-ceilometer.md - Monitoring: - Monitoring Overview: prometheus-monitoring-overview.md - Getting Started: monitoring-getting-started.md @@ -196,6 +196,7 @@ nav: - Kube-OVN Monitoring: prometheus-kube-ovn.md - RabbitMQ Exporter: prometheus-rabbitmq-exporter.md - Memcached Exporter: prometheus-memcached-exporter.md + - MariaDB Exporter: prometheus-mysql-exporter.md - Postgres Exporter: prometheus-postgres-exporter.md - Openstack Exporter: prometheus-openstack-metrics-exporter.md - Blackbox Exporter: prometheus-blackbox-exporter.md