Skip to content

Commit

Permalink
fix: updates doc nav
Browse files Browse the repository at this point in the history
This simple change updates the nav in a couple places that didn't make sense.

Signed-off-by: Kevin Carter <[email protected]>
  • Loading branch information
cloudnull committed Mar 7, 2024
1 parent 0001c5d commit af0b36e
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 101 deletions.
5 changes: 3 additions & 2 deletions docs/build-test-envs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
62 changes: 0 additions & 62 deletions docs/components.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
17 changes: 0 additions & 17 deletions docs/infrastructure-ovn-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
5 changes: 3 additions & 2 deletions docs/openstack-cinder.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
13 changes: 8 additions & 5 deletions docs/storage-ceph-rook-internal.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand All @@ -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}}}"
```
Expand Down
9 changes: 6 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit af0b36e

Please sign in to comment.