Merge ~mthaddon/charm-k8s-ingress/+git/charm-k8s-ingress:readme-define-controller into charm-k8s-ingress:master

Proposed by Tom Haddon
Status: Merged
Approved by: Jon Seager
Approved revision: 995cbb45085e46cea22d29b81523e9ef07300735
Merged at revision: 1fec55d3fc1c3aa3dc127e34bf2b7435eba7a072
Proposed branch: ~mthaddon/charm-k8s-ingress/+git/charm-k8s-ingress:readme-define-controller
Merge into: charm-k8s-ingress:master
Diff against target: 25 lines (+10/-5)
1 file modified
README.md (+10/-5)
Reviewer Review Type Date Requested Status
ingress-charmers Pending
Review via email: mp+403069@code.launchpad.net

Commit message

Rewrite description in README to define how this charm interacts with an ingress controller to provide ingress

Description of the change

Rewrite description in README to define how this charm interacts with an ingress controller to provide ingress

To post a comment you must log in.
Revision history for this message
🤖 Canonical IS Merge Bot (canonical-is-mergebot) wrote :

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

Revision history for this message
🤖 Canonical IS Merge Bot (canonical-is-mergebot) wrote :

Change successfully merged at revision 1fec55d3fc1c3aa3dc127e34bf2b7435eba7a072

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/README.md b/README.md
2index c24b8cc..1a785a1 100644
3--- a/README.md
4+++ b/README.md
5@@ -2,11 +2,16 @@
6
7 ## Description
8
9-This charm is intended to provide an nginx ingress for sidecar charms using the
10-Operator Framework until such time as Juju can expose the relevant primitives
11-to enable charms to configure an ingress natively via Juju (e.g. with TLS as
12-required, with session affinity as required, allowing for upload of a given
13-size, etc.).
14+This charm generates an Nginx Ingress resource for sidecar charms using the
15+Operator Framework. This resource can then be used by an Nginx Ingress Controller
16+in a Kubernetes cluster to expose HTTP and HTTPS routes from outside the cluster
17+to a charm running within the cluster. As such, this charm requires your
18+Kubernetes cluster to have an Nginx Ingress Controller already deployed to it.
19+
20+For more information about Ingress Controllers, [see here](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/).
21+To enable an Nginx Ingress Controller on MicroK8s, just run `microk8s enable ingress`,
22+or if you're using [Charmed Kubernetes](https://ubuntu.com/kubernetes) you can
23+enable it with `juju expose kubernetes-worker`.
24
25 ## Usage
26

Subscribers

People subscribed via source and target branches

to all changes: