Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: new doc updates #161

Merged
merged 1 commit into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Encore Alerts

The following example describes configuration options to send alerts via alertmanager to
Rackspace encore, the `Encore UUID` is derived by account where the secret `SECRET KEY` is
used per application submitting webhooks:

```yaml
``` yaml
global:
resolve_timeout: 5m
receivers:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Slack Alerts

The following example describes configuration options to send alerts via alertmanager to slack
using a slack hook.
Expand Down
25 changes: 25 additions & 0 deletions docs/genestack-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,28 @@ An update is generally the same as an install. Many of the Genestack application

* When needing to run an upgrade for the infrastructure operators, consult the operator documentation to validate the steps required.
* When needing to run an upgrade for the OpenStack components, simply re-run the `helm` charts as documented in the Genestack installation process.

## Kubernetes Upgrade Notes

Over the course of normal operations it's likely that a CRD will change versions, names, or something else. In these cases, should an operator or helm chart not gracefully handle an full upgrade, the `kubectl convert` plugin can be used to make some adjustments where needed.

!!! example "Converting mmontes CRDs to mariadb official ones"

``` shell
kubectl get --namespace openstack crd.namespace -o yaml value > /tmp/value.crd.namespace.yaml
kubectl convert -f /tmp/value.crd.namespace.yaml --output-version new-namespace/VERSION
```

## Kubernetes Finalizers

When processing an upgrade there may come a time when a finalizer is stuck, typically something that happens when an operator or an api reference is changed. If this happens one way to resolve the issue is to patch the Finalizers.

!!! warning

Patching Finalizers could leave orphaned resources. Before patching a finalizer be sure your "ready."

!!! example "Patching Finalizers"

``` shell
kubectl patch $@ --type='json' -p='[{"op": "remove", "path": "/metadata/finalizers"}]'
```
12 changes: 10 additions & 2 deletions docs/k8s-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,16 @@ Install the `kubectl` tool.

``` shell
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
sudo mv kubectl /usr/local/bin/
sudo chmod +x /usr/local/bin/kubectl
sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
```

### Install the `convert` plugin

The convert plugin can be used to assist with upgrades.

``` shell
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl-convert"
sudo install -o root -g root -m 0755 kubectl-convert /usr/local/bin/kubectl-convert
```

## Retrieve the kube config
Expand Down
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ nav:
- Kubernetes Dashboard: k8s-dashboard.md
- Kubernetes Taint: k8s-taint.md
- Retrieve kube config: k8s-config.md
- Prometheus: prometheus.md
- Storage:
- storage-overview.md
- Ceph Internal: storage-ceph-rook-internal.md
Expand Down Expand Up @@ -185,13 +186,15 @@ nav:
- Ceilometer: openstack-ceilometer.md
- Monitoring:
- Monitoring Overview: prometheus-monitoring-overview.md
- Prometheus: prometheus.md
- Grafana: grafana.md
- MySQL Exporter: prometheus-mysql-exporter.md
- RabbitMQ Exporter: prometheus-rabbitmq-exporter.md
- Memcached Exporter: prometheus-memcached-exporter.md
- Postgres Exporter: prometheus-postgres-exporter.md
- Openstack Exporter: prometheus-openstack-metrics-exporter.md
- Alert Manager Examples:
- alertmanager-encore.md
- alertmanager-slack.md
- Operational Guide:
- Running Genestack Upgrade: genestack-upgrade.md
- Running Kubespray Upgrade: k8s-kubespray-upgrade.md
Expand Down
Loading