Merge ~barryprice/charm-k8s-bind/+git/charm-k8s-bind:wrapper into ~barryprice/charm-k8s-bind/+git/charm-k8s-bind:master

[Barry Price]

Convert from using both ENTRYPOINT and CMD to a single wrapper script that sets up our config and then starts the bind service

287bc61... by Barry Price on 2021-05-19

Repoint shellcheck to renamed file

Unmerged commits

287bc61... by Barry Price on 2021-05-19

Repoint shellcheck to renamed file

2341d51... by Barry Price on 2021-05-19

Convert from using both ENTRYPOINT and CMD to a single wrapper script that sets up our config and then starts the bind service

062a222... by Tom Haddon on 2021-05-18

Rename charm for consistency with others

Reviewed-on: https://code.launchpad.net/~mthaddon/charm-k8s-bind/+git/charm-k8s-bind/+merge/402883
Reviewed-by: Barry Price <email address hidden>

a2bf1f0... by Tom Haddon on 2021-05-18

Update README for new charm name

5f5b4f4... by Tom Haddon on 2021-05-18

Rename charm for consistency with others

0a8dd26... by Tom Haddon on 2020-12-14

Update README and metadata.yaml to be more end-user focused

Reviewed-on: https://code.launchpad.net/~mthaddon/charm-k8s-bind/+git/charm-k8s-bind/+merge/395302
Reviewed-by: Laurent Sesques <email address hidden>

3adff97... by Tom Haddon on 2020-12-14

Update README and metadata.yaml to be more end-user focused

89e8f48... by Tom Haddon on 2020-12-09

Remove unnecessary reference to config.yaml in README

Reviewed-on: https://code.launchpad.net/~mthaddon/charm-k8s-bind/+git/charm-k8s-bind/+merge/395069
Reviewed-by: Laurent Sesques <email address hidden>

ac4ab68... by Tom Haddon on 2020-12-09

Remove unnecessary reference to config.yaml in README

ff88d40... by Barry Price on 2020-11-06

Clean up docs, and explain how to work around the recursion default

Reviewed-on: https://code.launchpad.net/~barryprice/charm-k8s-bind/+git/charm-k8s-bind/+merge/393440
Reviewed-by: Benjamin Allot <email address hidden>

diff --git a/.jujuignore b/.jujuignore
index e8eb682..128851d 100644
--- a/.jujuignore
+++ b/.jujuignore
@@ -1,4 +1,5 @@
 *~
+*.charm
 .coverage
 .gitignore
 __pycache__
diff --git a/Makefile b/Makefile
index 6e99731..564aeb9 100644
--- a/Makefile
+++ b/Makefile
@@ -12,7 +12,7 @@ lint: blacken
 
 # We actually use the build directory created by charmcraft,
 # but the .charm file makes a much more convenient sentinel.
-unittest: bind.charm
+unittest: bind-k8s.charm
 	@tox -e unit
 
 test: lint unittest
@@ -21,7 +21,7 @@ clean:
 	@echo "Cleaning files"
 	@git clean -fXd
 
-bind.charm: src/*.py requirements.txt
+bind-k8s.charm: src/*.py requirements.txt
 	charmcraft build
 
 image-deps:
@@ -30,7 +30,7 @@ image-deps:
 
 image-lint: image-deps
 	@echo "Running shellcheck."
-	@shellcheck image-scripts/docker-entrypoint.sh
+	@shellcheck image-scripts/docker-wrapper.sh
 	@shellcheck image-scripts/dns-check.sh
 
 image-build: image-lint
diff --git a/README.md b/README.md
index c0b037d..3e31d97 100644
--- a/README.md
+++ b/README.md
@@ -1,74 +1,37 @@
-# Bind charm
+# Bind Operator
 
 A Juju charm deploying Bind, configurable to use a git repository for its configuration files.
 
 ## Overview
 
-This is a k8s workload charm and can only be deployed to a Juju k8s cloud,
-attached to a controller using `juju add-k8s`.
+BIND 9 has evolved to be a very flexible, full-featured DNS system. Whatever
+your application is, BIND 9 probably has the required features. As the first,
+oldest, and most commonly deployed solution, there are more network engineers
+who are already familiar with BIND 9 than with any other system.
 
-This charm is not currently ready for production due to issues with providing
-an egress to route TCP and UDP traffic to the pods. See:
+## Usage
 
-https://bugs.launchpad.net/charm-k8s-bind/+bug/1889746
-
-https://bugs.launchpad.net/juju/+bug/1889703
-
-## Details
-
-See config option descriptions in config.yaml.
-
-## Getting Started
-
-Notes for deploying a test setup locally using microk8s, the setup of which is
-documented here: https://juju.is/docs/microk8s-cloud
+For details on using Kubernetes with Juju [see here](https://juju.is/docs/kubernetes), and for
+details on using Juju with MicroK8s for easy local testing [see here](https://juju.is/docs/microk8s-cloud).
 
+To deploy this charm in a juju k8s model:
 ```
-juju add-model bind-test
+juju deploy bind-k8s
 ```
-
-1. Either deploy with the default image from Dockerhub:
-
-```
-juju deploy cs:~bind-charmers/bind
-```
-2. Or optionally build your own image locally and deploy with that
-
-```
-sudo snap install charmcraft
-git clone https://git.launchpad.net/charm-k8s-bind
-cd charm-k8s-bind
-make image-build
-docker push localhost:32000/bind
-juju deploy cs:~bind-charmers/bind --config bind_image_path=localhost:32000/bind:latest bind
-
-juju wait
-juju status
-```
-
-Assuming you're using the image from dockerhub, or an image built locally from
-this repo without changes, the charm will deploy bind with its stock Ubuntu
-package configuration, which will forward all queries to root name servers.
+The charm will deploy bind with its stock Ubuntu package configuration, which
+will forward all queries to root name servers.
 
 DNSSEC is also enabled by default.
 
 Custom config can be deployed by setting the `custom_config_repo` option to
 point to a Git repository containing a valid set of configuration files with
-which to populate the /etc/bind/ directory within the pod(s).
+which to populate the `/etc/bind/` directory within the pod(s).
 
 Since bind won't allow recursion from external clients by default, to allow
-easy testing, I've set up a repo with a copy of the stock config, modified to
-allow recursion from all RFC1918 networks:
-
-https://code.launchpad.net/~barryprice/junk/+git/etc-bind-stock-config-with-all-rfc1918-nets-allowed
-
-To configure a local microk8s-deployed bind application to use this config,
-simply run:
-
+easy testing, you can use [a repo with a copy of the stock config, modified to allow recursion from all RFC1918 networks](https://code.launchpad.net/~barryprice/junk/+git/etc-bind-stock-config-with-all-rfc1918-nets-allowed):
 ```
-juju config bind custom_config_repo=https://git.launchpad.net/~barryprice/junk/+git/etc-bind-stock-config-with-all-rfc1918-nets-allowed
+juju config bind-k8s custom_config_repo=https://git.launchpad.net/~barryprice/junk/+git/etc-bind-stock-config-with-all-rfc1918-nets-allowed
 ```
-
 Once the application is ready, you should be able to query the App's IP address
 (not the Unit addresses) directly from your local machine:
 
@@ -81,10 +44,16 @@ bind-test  myk8s-localhost  myk8s/localhost  2.8.6    unsupported  16:44:30+07:0
 App   Version    Status  Scale  Charm  Store       Rev  OS          Address         Notes
 bind  bind:edge  active      1  bind   jujucharms    2  kubernetes  10.152.183.246
 
-Unit     Workload  Agent  Address     Ports          Message
-bind/0*  active    idle   10.1.25.35  53/TCP,53/UDP  Pod configured
+Unit         Workload  Agent  Address     Ports          Message
+bind-k8s/0*  active    idle   10.1.25.35  53/TCP,53/UDP  Pod configured
 
 $ dig +short example.com @10.152.183.246
 93.184.216.34
 $
 ```
+
+## Known Issues
+
+This charm is unable to provide an ingress to route TCP and UDP traffic to the
+pods due to [LP#1889703](https://bugs.launchpad.net/juju/+bug/1889703). This is
+also being tracked as [a bug against the charm itself](https://bugs.launchpad.net/charm-k8s-bind/+bug/1889746).
diff --git a/dockerfile b/dockerfile
index 968d4fd..4215462 100644
--- a/dockerfile
+++ b/dockerfile
@@ -29,5 +29,4 @@ RUN chmod 0755 /usr/local/bin/dns-check.sh
 EXPOSE 53/udp
 EXPOSE 53/tcp
 
-ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]
-CMD /usr/sbin/named -g -u bind -c /etc/bind/named.conf
+CMD ["/usr/local/bin/docker-wrapper.sh"]
diff --git a/image-scripts/docker-entrypoint.sh b/image-scripts/docker-wrapper.sh
similarity index 97%
rename from image-scripts/docker-entrypoint.sh
rename to image-scripts/docker-wrapper.sh
index 2ed0857..4f807e1 100644
--- a/image-scripts/docker-entrypoint.sh
+++ b/image-scripts/docker-wrapper.sh
@@ -21,3 +21,5 @@ if [ -d "${BIND_CONFDIR}" ]; then
 else
 	echo "Something went wrong, ${BIND_CONFDIR} does not exist, not starting";
 fi
+
+/usr/sbin/named -g -u bind -c /etc/bind/named.conf
diff --git a/metadata.yaml b/metadata.yaml
index 12075b3..6c09e29 100644
--- a/metadata.yaml
+++ b/metadata.yaml
@@ -1,6 +1,10 @@
-name: "bind"
-summary: "Bind"
-description: "The original, complete open source DNS implementation"
+name: bind-k8s
+display-name: Bind
+summary: The original, complete open source DNS implementation.
+docs: https://discourse.charmhub.io/t/bind-documentation-overview/3973
+description: |
+  The original, complete open source DNS implementation.
+  https://www.isc.org/bind/
 min-juju-version: 2.8.0
 maintainers:
   - https://launchpad.net/~bind-charmers <[e-mail]>
diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py
index 85fe103..3938f12 100644
--- a/tests/unit/test_charm.py
+++ b/tests/unit/test_charm.py
@@ -117,7 +117,7 @@ class TestBindK8s(unittest.TestCase):
             'version': 2,
             'containers': [
                 {
-                    'name': 'bind',
+                    'name': 'bind-k8s',
                     'imageDetails': {'imagePath': 'example.com/bind:v1'},
                     'ports': [
                         {'containerPort': 53, 'name': 'domain-tcp', 'protocol': 'TCP'},
@@ -137,7 +137,7 @@ class TestBindK8s(unittest.TestCase):
             'version': 2,
             'containers': [
                 {
-                    'name': 'bind',
+                    'name': 'bind-k8s',
                     'imageDetails': {
                         'imagePath': 'secure.example.com/bind:v1',
                         'username': 'test-user',
@@ -161,7 +161,7 @@ class TestBindK8s(unittest.TestCase):
             'version': 2,
             'containers': [
                 {
-                    'name': 'bind',
+                    'name': 'bind-k8s',
                     'imageDetails': {'imagePath': 'example.com/bind:v1'},
                     'ports': [
                         {'containerPort': 53, 'name': 'domain-tcp', 'protocol': 'TCP'},
@@ -181,7 +181,7 @@ class TestBindK8s(unittest.TestCase):
             'version': 2,
             'containers': [
                 {
-                    'name': 'bind',
+                    'name': 'bind-k8s',
                     'imageDetails': {'imagePath': 'example.com/bind:v1'},
                     'ports': [
                         {'containerPort': 53, 'name': 'domain-tcp', 'protocol': 'TCP'},
@@ -201,7 +201,7 @@ class TestBindK8s(unittest.TestCase):
             'version': 2,
             'containers': [
                 {
-                    'name': 'bind',
+                    'name': 'bind-k8s',
                     'imageDetails': {'imagePath': 'example.com/bind:v1'},
                     'ports': [
                         {'containerPort': 53, 'name': 'domain-tcp', 'protocol': 'TCP'},