Merge ~mthaddon/content-cache-charm/+git/content-cache-charm:sites-and-secrets-docs into content-cache-charm:master

[Tom Haddon]

Update documentation now that we have sites config in discourse-based docs, and change backend path in unit tests to make more obviously a secret

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Haw Loeung (hloeung)]

LGTM

review: Approve (+1)

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision ef8a5987454ee267589f72a4e3ab9d8bd7196819

diff --git a/README.md b/README.md
index d7fae8e..f2f1068 100644
--- a/README.md
+++ b/README.md
@@ -23,50 +23,7 @@ To deploy the charm:
 
     juju deploy content-cache
 
-Set juju config for the `sites` option as required. For example:
-
-    # Site with some public, some authenticated content, using another site
-    # with two IPs for authentication. In this case, 10.1.1.2 and 10.1.1.3
-    # would need to listen on 443 for auth.example1.com and process
-    # authentication requests. If set, cache-maxconn will set the maximum
-    # number of simultaneous connections to the nginx cache for this location,
-    # while backend-maxconn limits connections to the defined backends.
-    # If unset, both will default to 2048
-    example1.com:
-      tls-cert-bundle-path: /var/lib/haproxy
-      locations:
-        '/':
-          extra-config:
-            - root /srv/example1.com/content/
-            - autoindex on
-        '/auth':
-          modifier: '='
-          backends:
-            - 10.1.1.2:443
-            - 10.1.1.3:443
-          backend-check-path: /status
-          backend-inter-time: '10s'
-          backend-maxconn: 64
-          backend-path: /auth-check/
-          backend-tls: True
-          cache-maxconn: 4096
-          cache-validity: '200 401 1h'
-          origin-headers:
-            - Original-URI: $request_uri
-            - Resource-Name: example1
-          extra-config:
-            - internal
-            - proxy_cache_key $http_authorization
-          site-name: auth.example1.com
-        '/status':
-          extra-config:
-            - stub_status on
-        '/private/content/':
-          extra-config:
-            - root /srv/example1.com/content/
-            - autoindex on
-            - auth_request /auth
-          nagios-expect: 401 Unauthorized
+For details on configuring sites, see [the sites configuration documentation](https://charmhub.io/content-cache/docs/sites-configuration).
 
 ## Metrics
 
diff --git a/config.yaml b/config.yaml
index e6d4a69..4ee5f31 100644
--- a/config.yaml
+++ b/config.yaml
@@ -113,7 +113,7 @@ options:
     default: ""
     type: string
     description: >
-      YAML-formatted virtual hosts/sites. See the README.md for more details
+      YAML-formatted virtual hosts/sites. See https://charmhub.io/content-cache/docs/sites-configuration for more details
       and examples.
   sites_secrets:
     default: ""
@@ -123,9 +123,12 @@ options:
       site1.local:
         locations:
           "/":
+            backend-path: /my-backend-path-secret/
             origin-headers:
               X-Origin-Key: my-origin-secret-key
             signed-url-hmac-key: my-signed-url-secret-key
+      See https://charmhub.io/content-cache/docs/sites-secrets-configuration for more details
+      and examples.
   tls_cipher_suites:
     default: ""
     type: string
diff --git a/tests/unit/files/config_test_secrets.txt b/tests/unit/files/config_test_secrets.txt
index fb50f1a..d74cbd0 100644
--- a/tests/unit/files/config_test_secrets.txt
+++ b/tests/unit/files/config_test_secrets.txt
@@ -1,7 +1,7 @@
 site1.local:
   locations:
     /:
+      backend-path: /ui4rohJ2ohngah7yi4uY/
       origin-headers:
         X-Origin-Key: Sae6oob2aethuosh
       signed-url-hmac-key: xooBaLemenae6voopooz
-      backend-path: /v/
diff --git a/tests/unit/files/nginx_config_rendered_test_output-site1.local-secrets.txt b/tests/unit/files/nginx_config_rendered_test_output-site1.local-secrets.txt
index 4ff34b6..8c4608b 100644
--- a/tests/unit/files/nginx_config_rendered_test_output-site1.local-secrets.txt
+++ b/tests/unit/files/nginx_config_rendered_test_output-site1.local-secrets.txt
@@ -9,7 +9,7 @@ server {
 
     location / {
         proxy_http_version 1.1;
-        proxy_pass http://localhost:8080/v/;
+        proxy_pass http://localhost:8080/ui4rohJ2ohngah7yi4uY/;
         proxy_set_header Host "site1.local";
         # Removed the following headers to avoid cache poisoning.
         proxy_set_header Forwarded "";