Skip to content

Commit

Permalink
Update integrations.md (ISD-2321)
Browse files Browse the repository at this point in the history
- Update formatting of "Interface" and "Supported charms" lines
- Put commands into command blocks
- Change relate to integrate
  • Loading branch information
erinecon authored Oct 2, 2024
1 parent 15416d0 commit 4be36f9
Showing 1 changed file with 25 additions and 7 deletions.
32 changes: 25 additions & 7 deletions docs/reference/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ charm enables additional `blog_hostname` and `use_nginx_ingress_modesec` configu
kubernetes cluster must already have an nginx ingress controller already deployed. Documentation to
enable ingress in microk8s can be found [here](https://microk8s.io/docs/addon-ingress).

Example ingress relate command: `juju relate wordpress-k8s nginx-ingress-integrator`
Example ingress integrate command:
```
juju integrate wordpress-k8s nginx-ingress-integrator
```

### metrics-endpoint

Expand All @@ -24,7 +27,10 @@ apache’s `/server-status` route is not exposed and can only be accessed from w
Kubernetes pod. The metrics are exposed in the [open metrics format](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#data-model) and will only be scraped by Prometheus once the relation becomes active. For more
information about the metrics exposed, please refer to the apache-exporter [documentation](https://github.com/Lusitaniae/apache_exporter#collectors).

Metrics-endpoint relate command: `juju relate wordpress-k8s prometheus-k8s`
Metrics-endpoint integrate command:
```
juju integrate wordpress-k8s prometheus-k8s
```

### logging

Expand All @@ -35,7 +41,10 @@ Logging relation through the `loki_push_api` interface installs and runs promtai
contents of local logs found at `/var/log/apache2/access.log` and `/var/log/apache2/error.log` to Loki.
This can then be queried through the loki api or easily visualized through Grafana.

Logging-endpoint relate command: `juju relate wordpress-k8s loki-k8s`
Logging-endpoint integrate command:
```
juju integrate wordpress-k8s loki-k8s
```

### grafana-dashboard

Expand All @@ -48,16 +57,25 @@ be found at `/src/grafana_dashboards/wordpress.json`. In Grafana UI, it can be f
Operator Overview” under the General section of the dashboard browser (`/dashboards`). Modifications
to the dashboard can be made but will not be persisted upon restart/redeployment of the charm.

Grafana-Prometheus relate command: `juju relate grafana-k8s:grafana-source prometheus-k8s:grafana-source`
Grafana-dashboard relate command: `juju relate wordpress-k8s grafana-dashboard`
Grafana-Prometheus integrate command:
```
juju integrate grafana-k8s:grafana-source prometheus-k8s:grafana-source
```
Grafana-dashboard integrate command:
```
juju integrate wordpress-k8s grafana-dashboard
```

### database:

_Interface_: mysql_client
_Interface_: mysql_client
_Supported charms_: [Charmed MySQL](https://charmhub.io/mysql), [Charmed MySQL-K8s](https://charmhub.io/mysql-k8s)

Database endpoint can be related to mysql based charms, providing long term storage for wordpress.
Database relation connect wordpress-k8s with charms that support the `mysql_client` interface on port 3306
in the database side.

Example database relate command: juju relate wordpress-k8s:database mysql-k8s:database
Example database integrate command:
```
juju integrate wordpress-k8s:database mysql-k8s:database
```

0 comments on commit 4be36f9

Please sign in to comment.