Barry Price has proposed merging ~barryprice/charm-k8s-bind/+git/charm-k8s-bind:readme into charm-k8s-bind:master.
Commit message: First draft of README.md Requested reviews: Bind Charmers (bind-charmers) Related bugs: Bug #1889760 in charm-k8s-bind: "README.md needed" https://bugs.launchpad.net/charm-k8s-bind/+bug/1889760 For more details, see: https://code.launchpad.net/~barryprice/charm-k8s-bind/+git/charm-k8s-bind/+merge/389321 -- Your team Bind Charmers is requested to review the proposed merge of ~barryprice/charm-k8s-bind/+git/charm-k8s-bind:readme into charm-k8s-bind:master.
diff --git a/README.md b/README.md new file mode 100644 index 0000000..599a94b --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# Bind charm + +A juju charm deploying Bind, using a custom-built image 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`. + +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: + +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: + + sudo snap install juju --classic + sudo snap install juju-wait --classic + sudo snap install microk8s --classic + sudo snap alias microk8s.kubectl kubectl + sudo snap install charmcraft + git clone https://git.launchpad.net/charm-k8s-bind + make bind.charm + + microk8s.reset # Warning! Clean slate! + microk8s.enable dns dashboard registry storage + microk8s.status --wait-ready + microk8s.config | juju add-k8s myk8s --client + + # Build your Bind image + make build-image + docker push localhost:32000/bind + + juju bootstrap myk8s + juju add-model bind-test + juju deploy ./bind.charm --config bind_image_path=localhost:32000/bind:latest bind + juju wait + juju status + +By default, 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).
-- Mailing list: https://launchpad.net/~bind-charmers Post to : [email protected] Unsubscribe : https://launchpad.net/~bind-charmers More help : https://help.launchpad.net/ListHelp
