From af0b36e481c1ddfd46bd213c6bc8791e184a5652 Mon Sep 17 00:00:00 2001 From: Kevin Carter Date: Wed, 6 Mar 2024 19:20:54 -0600 Subject: [PATCH] fix: updates doc nav This simple change updates the nav in a couple places that didn't make sense. Signed-off-by: Kevin Carter --- docs/build-test-envs.md | 5 ++- docs/components.md | 62 ------------------------------ docs/index.md | 10 ----- docs/infrastructure-ovn-setup.md | 17 -------- docs/openstack-cinder.md | 5 ++- docs/storage-ceph-rook-internal.md | 13 ++++--- mkdocs.yml | 9 +++-- 7 files changed, 20 insertions(+), 101 deletions(-) delete mode 100644 docs/components.md diff --git a/docs/build-test-envs.md b/docs/build-test-envs.md index 6d3d143a..a24d96b5 100644 --- a/docs/build-test-envs.md +++ b/docs/build-test-envs.md @@ -74,8 +74,9 @@ Run the test infrastructure deployment. > Ensure `os_cloud_name` as well as other values within your `infra-deploy.yaml` match a valid cloud name in your openstack configuration as well as resource names within it. -> [!IMPORTANT] -> Pay close attention to the values for both `kube_ovn_iface` and `kube_ovn_default_interface_name`, they will need to match the desired interface name(s) within your test hosts! +!!! note + + Pay close attention to the values for both `kube_ovn_iface` and `kube_ovn_default_interface_name`, they will need to match the desired interface name(s) within your test hosts! ``` shell ansible-playbook -i localhost, infra-deploy.yaml diff --git a/docs/components.md b/docs/components.md deleted file mode 100644 index 483f6a9e..00000000 --- a/docs/components.md +++ /dev/null @@ -1,62 +0,0 @@ -# Product Component Matrix - -The following components are part of the initial product release -and largely deployed with Helm+Kustomize against the K8s API (v1.28 and up). -Some components are intially only installed with the public cloud based, -OpenStack Flex, service, while OpenStack Enterprise naturally provides a larger -variety of services: - -| Group | Component | OpenStack Flex | OpenStack Enterprise | -|------------|----------------------|----------------|----------------------| -| Kubernetes | Kubernetes | Required | Required | -| Kubernetes | Kubernetes Dashboard | Required | Required | -| Kubernetes | Cert-Manager | Required | Required | -| Kubernetes | MetaLB (L2/L3) | Required | Required | -| Kubernetes | Core DNS | Required | Required | -| Kubernetes | Ingress Controller (Nginx) | Required | Required | -| Kubernetes | Kube-Proxy (IPVS) | Required | Required | -| Kubernetes | Calico | Optional | Required | -| Kubernetes | Kube-OVN | Required | Optional | -| Kubernetes | Helm | Required | Required | -| Kubernetes | Kustomize | Required | Required | -| OpenStack | openVswitch (Helm) | Optional | Required | -| OpenStack | Galera (Operator) | Required | Required | -| OpenStack | rabbitMQ (Operator) | Required | Required | -| OpenStack | memcacheD (Operator) | Required | Required | -| OpenStack | Ceph Rook | Optional | Required | -| OpenStack | iscsi/tgtd | Required | Optional | -| OpenStack | Keystone (Helm) | Required | Required | -| OpenStack | Glance (Helm) | Required | Required | -| OpenStack | Cinder (Helm) | Required | Required | -| OpenStack | Nova (Helm) | Required | Required | -| OpenStack | Neutron (Helm) | Required | Required | -| OpenStack | Placement (Helm) | Required | Required | -| OpenStack | Horizon (Helm) | Required | Required | -| OpenStack | Skyline (Helm) | Optional | Optional | -| OpenStack | Heat (Helm) | Required | Required | -| OpenStack | Designate (Helm) | Optional | Required | -| OpenStack | Barbican (Helm) | Required | Required | -| OpenStack | Octavia (Helm) | Required | Required | -| OpenStack | Ironic (Helm) | Optional | Required | -| OpenStack | metal3.io | Optional | Required | - -Initial monitoring componets consists of the following projects - -| Group | Component | OpenStack Flex | OpenStack Enterprise | -|------------|----------------------|----------------|----------------------| -| Kubernetes | Prometheus | Required | Required | -| Kubernetes | Thanos | Required | Required | -| Kubernetes | Alertmanager | Required | Required | -| Kubernetes | Grafana | Required | Required | -| Kubernetes | Node Exporter | Required | Required | -| Kubernetes | redfish Exporter | Required | Required | -| OpenStack | OpenStack Exporter | Required | Required | - -At a later stage these components will be added - -| Group | Component | OpenStack Flex | OpenStack Enterprise | -|-----------|----------------------|----------------|----------------------| -| OpenStack | MongoDB | Optional | Required | -| OpenStack | Aodh (Helm) | Optional | Required | -| OpenStack | Ceilometer (Helm) | Optional | Required | -| OpenStack | Masakari (Helm) | Optional | Required | diff --git a/docs/index.md b/docs/index.md index 60241d01..797a5809 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,13 +4,3 @@ Genestack — where Kubernetes and OpenStack tango in the cloud. Imagine a waltz what you need. Operators play the score, managing the complexity with a flick of their digital batons. They unify the chaos, making scaling and management a piece of cake. Think of it like a conductor effortlessly guiding a cacophony into a symphony. - -## Environment Architecture - -Genestack is making use of some homegrown solutions, community operators, and OpenStack-Helm. Everything -in Genestack comes together to form cloud in a new and exciting way; all built with opensource solutions -to manage cloud infrastructure in the way you need it. - -They say a picture is worth 1000 words, so here's a picture. - -![Genestack Architecture Diagram](assets/images/diagram-genestack.png) diff --git a/docs/infrastructure-ovn-setup.md b/docs/infrastructure-ovn-setup.md index b4ce0c29..3d50aaeb 100644 --- a/docs/infrastructure-ovn-setup.md +++ b/docs/infrastructure-ovn-setup.md @@ -90,20 +90,3 @@ kubectl apply -k /opt/genestack/kustomize/ovn After running the setup, nodes will have the label `ovn.openstack.org/configured` with a date stamp when it was configured. If there's ever a need to reconfigure a node, simply remove the label and the DaemonSet will take care of it automatically. - -## Validation our infrastructure is operational - -Before going any further make sure you validate that the backends are operational. - -``` shell -# MariaDB -kubectl --namespace openstack get mariadbs - -#RabbitMQ -kubectl --namespace openstack get rabbitmqclusters.rabbitmq.com - -# Memcached -kubectl --namespace openstack get horizontalpodautoscaler.autoscaling memcached -``` - -Once everything is Ready and online. Continue with the installation. diff --git a/docs/openstack-cinder.md b/docs/openstack-cinder.md index 360c8ee1..30586e99 100644 --- a/docs/openstack-cinder.md +++ b/docs/openstack-cinder.md @@ -112,8 +112,9 @@ to best operate your volume groups for your specific needs. With the volume groups and DNS setup on your target hosts, it is now time to deploy the volume services. The playbook `playbooks/deploy-cinder-volumes-reference.yaml` will be used to create a release target for our python code-base and deploy systemd services units to run the cinder-volume process. -> [!IMPORTANT] -> Consider the **storage** network on your Cinder hosts that will be accessible to Nova compute hosts. By default, the playbook uses `ansible_default_ipv4.address` to configure the target address, which may or may not work for your environment. Append var, i.e., `-e cinder_storage_network_interface=ansible_br_mgmt` to use the specified iface address in `cinder.conf` for `my_ip` and `target_ip_address` in `cinder/backends.conf`. **Interface names with a `-` must be entered with a `_` and be prefixed with `ansible`** +!!! note + + Consider the **storage** network on your Cinder hosts that will be accessible to Nova compute hosts. By default, the playbook uses `ansible_default_ipv4.address` to configure the target address, which may or may not work for your environment. Append var, i.e., `-e cinder_storage_network_interface=ansible_br_mgmt` to use the specified iface address in `cinder.conf` for `my_ip` and `target_ip_address` in `cinder/backends.conf`. **Interface names with a `-` must be entered with a `_` and be prefixed with `ansible`** #### Example without storage network interface override diff --git a/docs/storage-ceph-rook-internal.md b/docs/storage-ceph-rook-internal.md index 29c0fadb..5150b542 100644 --- a/docs/storage-ceph-rook-internal.md +++ b/docs/storage-ceph-rook-internal.md @@ -8,9 +8,9 @@ kubectl apply -k /opt/genestack/kustomize/rook-operator/ ## Deploy the Rook cluster -> [!IMPORTANT] -> Rook will deploy against nodes labeled `role=storage-node`. Make sure to have a look at the `/opt/genestack/kustomize/rook-cluster/rook-cluster.yaml` file to ensure it's setup to your liking, pay special attention to your `deviceFilter` -settings, especially if different devices have different device layouts. +!!! note + + Rook will deploy against nodes labeled `role=storage-node`. Make sure to have a look at the `/opt/genestack/kustomize/rook-cluster/rook-cluster.yaml` file to ensure it's setup to your liking, pay special attention to your `deviceFilter` settings, especially if different devices have different device layouts. ``` shell kubectl apply -k /opt/genestack/kustomize/rook-cluster/ @@ -31,8 +31,11 @@ Once the rook cluster is online with a HEALTH status of `HEALTH_OK`, deploy the ``` shell kubectl apply -k /opt/genestack/kustomize/rook-defaults ``` -> [!IMPORTANT] -> If installing prometheus after rook-ceph is installed, you may patch a running rook-ceph cluster with the following command: + +!!! note + + If installing prometheus after rook-ceph is installed, you may patch a running rook-ceph cluster with the following command. + ``` shell kubectl -n rook-ceph patch CephCluster rook-ceph --type=merge -p "{\"spec\": {\"monitoring\": {\"enabled\": true}}}" ``` diff --git a/mkdocs.yml b/mkdocs.yml index 5474238a..dc4b4daf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -82,7 +82,9 @@ edit_uri: "edit/main/docs" nav: - Welcome: index.md - - Components: components.md + - Overview: + - Components: genestack-components.md + - Architecture: genestack-architecture.md - Quickstart: - Building Virtual Environments: build-test-envs.md - Simple Setup: quickstart.md @@ -117,14 +119,15 @@ nav: - MariaDB Deployment: infrastructure-mariadb.md - MySQL Exporter: prometheus-mysql-exporter.md - PostgreSQL: infrastructure-postgresql.md - - RabbitMQ: infrastructure-rabbitmq.md + - RabbitMQ: + - RabbitMQ Deployment: infrastructure-rabbitmq.md + - RabbitMQ Exporter: prometheus-rabbitmq-exporter.md - Memcached: infrastructure-memcached.md - Libvirt: infrastructure-libvirt.md - OVN: - OVN Overview: infrastructure-ovn.md - OVN Setup: infrastructure-ovn-setup.md - MetalLB: infrastructure-metallb.md - - RabbitMQ Exporter: prometheus-rabbitmq-exporter.md - OpenStack: - OpenStack Overview: openstack-overview.md - OpenStack Preparations: openstack-helm-make.md