diff --git a/docs/explanation/lifecycle-events.md b/docs/explanation/lifecycle-events.md index 20eded6f..8e864ff7 100644 --- a/docs/explanation/lifecycle-events.md +++ b/docs/explanation/lifecycle-events.md @@ -21,7 +21,7 @@ uploaded content from the WordPress user. ### leader_elected -This event is fired when juju elects a leader unit among the replica peers. Wordpress-k8s charm +This event is fired when Juju elects a leader unit among the replica peers. Wordpress-k8s charm then responds by setting up secrets and sharing them with peers through peer relation databag if not already set. @@ -34,14 +34,14 @@ state and the desired state. See the list of ### wordpress_pebble_ready When this event is fired, wordpress-k8s charm installs, configures and starts Apache server for -WordPress through pebble if the storage is available. Configurations that are set dynamically +WordPress through Pebble if the storage is available. Configurations that are set dynamically include database connection and secrets used by the WordPress application. Dynamic configurations -are modified in `wp-config.php` file and the changes are pushed through pebble. +are modified in `wp-config.php` file and the changes are pushed through Pebble. ### apache_prometheus_exporter_pebble_ready This event signals that the `apache_prometheus_exporter` container is ready in the pod. Apache -prometheus exporter service is then started through pebble. +prometheus exporter service is then started through Pebble. ### wordpress-replica_relation_changed @@ -54,5 +54,5 @@ installed themes and plugins with the incoming list of themes and plugins. ### upgrade-charm -Upgrade charm event is fired on the upgrade charm command `juju refresh wordpress-k8s`. Sets up -secrets in peer-relation databag for upgraded deployment of WordPress if not already set. \ No newline at end of file +The `upgrade-charm` event is fired on the upgrade charm command `juju refresh wordpress-k8s`. The command sets up +secrets in peer-relation databag for upgraded deployment of WordPress if it was not already set. diff --git a/docs/explanation/oci-image.md b/docs/explanation/oci-image.md index 5e6470b2..4138ece6 100644 --- a/docs/explanation/oci-image.md +++ b/docs/explanation/oci-image.md @@ -13,9 +13,9 @@ happen during database relation changed, database relation joined or database co events. To facilitate the WordPress installation process, [WordPress CLI](https://make.wordpress.org/cli/handbook/guides/installing/) is embedded in the OCI -image during build step. The latest CLI php archive file from source is used. +image during the build step. The latest CLI php archive file from source is used. Currently, WordPress version 5.9.3 is used alongside Ubuntu 20.04 base image. The Ubuntu base image hasn't yet been upgraded to 22.04 due to an unsupported php version 8 for `wordpress-launchpad-integration` plugin (supported php version 7). All other plugins and themes use -the latest stable version by default, downloaded from the source. \ No newline at end of file +the latest stable version by default, downloaded from the source. diff --git a/docs/explanation/relations.md b/docs/explanation/relations.md index a82abd14..da01036c 100644 --- a/docs/explanation/relations.md +++ b/docs/explanation/relations.md @@ -35,8 +35,8 @@ more about COS [here](https://charmhub.io/topics/canonical-observability-stack). ### logging Logging relation is a part of the COS integration to enhance logging observability. The -wordpress-k8s charm satisfies the loki_push_api by integrating promtail that pushes apache logs to -Loki. Requires [loki-k8s](https://charmhub.io/loki-k8s) charm. Learn more about COS +wordpress-k8s charm satisfies the `loki_push_api` by integrating promtail that pushes apache logs to +Loki. Requires the [loki-k8s](https://charmhub.io/loki-k8s) charm. Learn more about COS [here](https://charmhub.io/topics/canonical-observability-stack). ### grafana-dashboard @@ -45,4 +45,4 @@ Grafana-dashboard is a part of the COS integration to enhance observability. Thi a pre-made dashboard used for monitoring Apache server hosting WordPress. The wordpress-k8s charm satisfies the `grafana_dashboard` interface by providing the pre-made dashboard template to the Grafana relation data bag under the "dashboards" key. Requires Prometheus datasource to be already -integrated with Grafana. \ No newline at end of file +integrated with Grafana. diff --git a/docs/how-to/configure-hostname.md b/docs/how-to/configure-hostname.md index a95e1259..5fa54a53 100644 --- a/docs/how-to/configure-hostname.md +++ b/docs/how-to/configure-hostname.md @@ -36,10 +36,10 @@ nginx-ingress-integrator/0* active idle wordpress-k8s/0* active idle ``` -Note the Service IP(s): next to nginx-ingress-integrator charm’s Status output. +Note the Service IP(s) next to nginx-ingress-integrator charm’s Status output. Test the ingress by sending a GET request to the service with `Host` headers. ``` curl -H "Host: " http:// -``` \ No newline at end of file +``` diff --git a/docs/how-to/configure-initial-settings.md b/docs/how-to/configure-initial-settings.md index 242eb01b..3212577b 100644 --- a/docs/how-to/configure-initial-settings.md +++ b/docs/how-to/configure-initial-settings.md @@ -1,6 +1,6 @@ -# How to configure initial settings\* +# How to configure initial settings -\*This only works when setting up WordPress initially, before database relation setup. Changing the +> **NOTE** This only works when setting up WordPress initially, before database relation setup. Changing the value afterwards has no effect. By providing configuration value for `initial_settings` at deployment, you can tweak a few @@ -22,4 +22,4 @@ WordPress(`http:///wp-admin/options-general.php`). You can also pass in the wordpress-k8s `configuration.yaml` file with the parameters above. See how to pass in a configuration file in the -[juju documentation](https://juju.is/docs/olm/manage-applications#heading--configure-an-application-during-deployment). \ No newline at end of file +[juju documentation](https://juju.is/docs/olm/manage-applications#heading--configure-an-application-during-deployment). diff --git a/docs/how-to/configure-object-storage.md b/docs/how-to/configure-object-storage.md index ccfec4a2..63d90265 100644 --- a/docs/how-to/configure-object-storage.md +++ b/docs/how-to/configure-object-storage.md @@ -16,8 +16,6 @@ installation. Source `openrc` and load the credentials by running source openrc && printenv | grep OS_ ``` -You should be able to see - The contents of the command above should look something similar to the following. ``` @@ -61,4 +59,4 @@ You can then configure wordpress-k8s charm using the yaml contents above. ``` juju config wordpress-k8s wp_plugin_openstack-objectstorage_config="$(cat )" -``` \ No newline at end of file +``` diff --git a/docs/how-to/enable-waf.md b/docs/how-to/enable-waf.md index d3f38a01..f08b0224 100644 --- a/docs/how-to/enable-waf.md +++ b/docs/how-to/enable-waf.md @@ -12,9 +12,9 @@ juju deploy nginx-ingress-integrator juju relate wordpress-k8s nginx-ingress-integrator ``` -### Enable Modsecurity 3.0 WAF\* +### Enable Modsecurity 3.0 WAF -\*This feature is only available for +> **NOTE** This feature is only available for [nginx-ingress-integrator](https://charmhub.io/nginx-ingress-integrator) charm. The modsecurity WAF is enabled by default. @@ -47,4 +47,4 @@ Annotations: nginx.ingress.kubernetes.io/enable-modsecurity: true Events: ``` -Note the `nginx.ingress.kubernetes.io/enable-modsecurity: true` annotation. \ No newline at end of file +Note the `nginx.ingress.kubernetes.io/enable-modsecurity: true` annotation. diff --git a/docs/how-to/integrate-with-cos.md b/docs/how-to/integrate-with-cos.md index 4f4e872c..e5a390d2 100644 --- a/docs/how-to/integrate-with-cos.md +++ b/docs/how-to/integrate-with-cos.md @@ -24,7 +24,7 @@ juju relate wordpress-k8s loki-k8s ### grafana-k8s -In order for the Grafana dashboard to function properly, grafana should be able to connect to +In order for the Grafana dashboard to function properly, Grafana should be able to connect to Prometheus and Loki as its datasource. Deploy and relate prometheus-k8s and lok-k8s charm with [grafana-k8s](https://charmhub.io/grafana-k8s) charm through `grafana-source` relation. @@ -37,7 +37,7 @@ juju relate prometheus-k8s:grafana-source grafana-k8s:grafana-source juju relate loki-k8s:grafana-source grafana-k8s:grafana-source ``` -Then, wordpress-k8s charm can be related with grafana using the `grafana-dashboard` relation with +Then, wordpress-k8s charm can be related with Grafana using the `grafana-dashboard` relation with `grafana_dashboard` interface. ``` @@ -48,9 +48,9 @@ To access the Grafana dashboard for wordpress-k8s charm, run the following comma credentials for admin access. ``` -juju run-action grafana-k8s/0 get-admin-password --wait +juju run grafana-k8s/0 get-admin-password ``` -You can now log into the grafana dashboard by visiting `http://:3000`. Navigate to +You can now log into the Grafana dashboard by visiting `http://:3000`. Navigate to `http://:3000/dashboards` and access the WordPress dashboard named Wordpress Operator -Overview. \ No newline at end of file +Overview. diff --git a/docs/how-to/retrieve-initial-credentials.md b/docs/how-to/retrieve-initial-credentials.md index 17adc753..a935b1ae 100644 --- a/docs/how-to/retrieve-initial-credentials.md +++ b/docs/how-to/retrieve-initial-credentials.md @@ -4,7 +4,7 @@ Run the following command to get the initial admin password that can be used to `http:///wp-login.php`. ``` -juju run-action wordpress-k8s/0 get-initial-password --wait +juju run wordpress-k8s/0 get-initial-password ``` The output of the action should look something similar to the following: @@ -20,5 +20,5 @@ unit-wordpress-k8s-0: You can use the password to login to the admin account in `http:///wp-admin.php`. -Note that if `admin_password` value has been passed in the `initial_settings` configuration, the -password from the action is invalid. \ No newline at end of file +> **NOTE** If the `admin_password` value was passed in the `initial_settings` configuration, the +password from the action is invalid. diff --git a/docs/how-to/rotate-secrets.md b/docs/how-to/rotate-secrets.md index 7ef0b630..f69c6542 100644 --- a/docs/how-to/rotate-secrets.md +++ b/docs/how-to/rotate-secrets.md @@ -3,7 +3,7 @@ To securely update all the WordPress secrets, run the following action. ``` -juju run-action wordpress-k8s/0 rotate-wordpress-secrets –wait +juju run wordpress-k8s/0 rotate-wordpress-secrets ``` -This action will force users to be logged out. All sessions and cookies will be invalidated. \ No newline at end of file +This action will force users to be logged out. All sessions and cookies will be invalidated. diff --git a/docs/index.md b/docs/index.md index 10c60898..1da3a169 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,10 +25,10 @@ The WordPress Operator is a member of the Ubuntu family. It's an open-source pro - [Code of conduct](https://ubuntu.com/community/code-of-conduct) - [Get support](https://discourse.charmhub.io/) -- [Join our online chat](https://chat.charmhub.io/charmhub/channels/charm-dev) +- [Join our online chat](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) - [Contribute](Contribute) -Thinking about using the WordPress Operator for your next project? [Get in touch](https://chat.charmhub.io/charmhub/channels/charm-dev)! +Thinking about using the WordPress Operator for your next project? [Get in touch](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)! # Contents @@ -56,4 +56,4 @@ Thinking about using the WordPress Operator for your next project? [Get in touch 1. [Containers](explanation/containers.md) 1. [Lifecycle events](explanation/lifecycle-events.md) 1. [OCI image](explanation/oci-image.md) - 1. [Relations](explanation/relations.md) \ No newline at end of file + 1. [Relations](explanation/relations.md) diff --git a/docs/reference/plugins.md b/docs/reference/plugins.md index c815c0e2..1c816a74 100644 --- a/docs/reference/plugins.md +++ b/docs/reference/plugins.md @@ -2,7 +2,7 @@ By default, the following WordPress plugins are installed with the latest version during the OCI image build time. If the plugins are installed during runtime with -`juju config wordpress-k8s plugins=`, the plugin will also be installed to it's latest +`juju config wordpress-k8s plugins=`, the plugin will also be installed to its latest version by default and may cause version differences between pods. The wordpress-k8s charm supports multi-unit deployments. Therefore, installing plugins through UI has been disabled and can only be installed through the plugins configuration. Please see @@ -80,4 +80,4 @@ _\*The descriptions of the following plugins are taken from the WordPress plugin - [wp-statistics](https://wordpress.org/plugins/wp-statistics/): GDPR compliant website statistics tool. - [xubuntu-team-members](https://git.launchpad.net/~canonical-sysadmins/wordpress/+git/wp-plugin-xubuntu-team-members): - Adds the role "Xubuntu Team member" \ No newline at end of file + Adds the role "Xubuntu Team member" diff --git a/docs/tutorial.md b/docs/tutorial.md index 05bb15ba..1986461b 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -60,7 +60,7 @@ By running the `get-initial-password` action on a wordpress-k8s unit, juju will admin credentials setup for you. You can use the following command below. ``` -juju run-action wordpress-k8s/0 get-initial-password --wait +juju run wordpress-k8s/0 get-initial-password ``` The result should look something similar to the contents below: @@ -87,5 +87,5 @@ Congratulations! You have successfully finished the wordpress-k8s tutorial. You model environment that you’ve created using the following command. ``` -juju destroy model wordpress-tutorial -y --release-storage -``` \ No newline at end of file +juju destroy-model wordpress-tutorial --destroy-storage +```