wordpress-charmers team mailing list archive

[Tom Haddon <tom.haddon@xxxxxxxxxxxxx>]

Tom Haddon has proposed merging ~mthaddon/charm-k8s-wordpress/+git/charm-k8s-wordpress:readme-image-config into charm-k8s-wordpress:master.

Commit message:
Clarify in the the readme that you can use a private image



Requested reviews:
  Canonical IS Reviewers (canonical-is-reviewers)
  Wordpress Charmers (wordpress-charmers)

For more details, see:
https://code.launchpad.net/~mthaddon/charm-k8s-wordpress/+git/charm-k8s-wordpress/+merge/382837

Clarify in the the readme that you can use a private image


-- 
Your team Wordpress Charmers is requested to review the proposed merge of ~mthaddon/charm-k8s-wordpress/+git/charm-k8s-wordpress:readme-image-config into charm-k8s-wordpress:master.

diff --git a/README.md b/README.md
index 7361f8e..65c19a5 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # Wordpress k8s charm
 
 A Juju charm for a Kubernetes deployment of Wordpress, using the
-official Dockerhub Wordpress image or image built from this base.
+official Dockerhub Wordpress image or an image built from this base.
 
 ## Overview
 
@@ -10,11 +10,11 @@ attached to a controller using `juju add-k8s`.
 
 The image to spin up is specified in the `image` charm configuration
 option using standard docker notation (eg. 'localhost:32000/mywork-rev42').
-Images must be publicly accessible. Default is the Dockerhub
-`wordpress:php7.3` image.
+The default image is Dockerhub's `wordpress:php7.3` image, but you can also
+use private images by specifying `image_user` and `image_pass` charm
+configuration.
 
-Standard configuration for the Wordpress image is in standard Juju config.
-In particular:
+Configuration for the Wordpress image is in standard Juju config. In particular:
 
 * `db_host`, `db_user` & `db_password`. This charm may in future be relatable
    to a MySQL deployment, when the MySQL charm is updated to support cross
@@ -22,7 +22,7 @@ In particular:
 * `ports`. Custom images may require additional ports to be opened, such
    as those providing monitoring or metrics endpoints.
 
-Additional runtine configuration is specified as YAML snippets in the charm config.
+Additional runtime configuration is specified as YAML snippets in the charm config.
 Both `container_config` and `container_secrets` items are provided,
 and they are combined together. `container_config` gets logged,
 `container_secrets` does not. This allows you to configure customized
diff --git a/config.yaml b/config.yaml
index 2fa76b8..8e2081c 100644
--- a/config.yaml
+++ b/config.yaml
@@ -15,7 +15,7 @@ options:
     type: string
     description: >
        Ports to expose, space separated list in name:8000 format. Names are alphanumeric + hyphen.
-       eg. "http:80 metrics:7127"
+       e.g. "http:80 metrics:7127"
     default: "http:80"
   db_host:
     type: string
@@ -50,7 +50,7 @@ options:
   initial_settings:
       type: string
       description: >
-        Optional, YAML formatted, wordpress configuration. It is used only
+        Optional, YAML formatted, Wordpress configuration. It is used only
         during initial deployment. Changing it at later stage has no effect.
         If set to non empty string required keys are: