Skip to content
This repository was archived by the owner on Nov 30, 2021. It is now read-only.

Commit b8e404c

Browse files
krisnovamboersma
authored andcommitted
chore(ingress): Documentation updates from code review
Changing documentation per the code review, mostly typos and wordsmithing. Non breaking change
1 parent 9f5bcea commit b8e404c

4 files changed

Lines changed: 16 additions & 13 deletions

File tree

charts/workflow/values.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ global:
5151
host_port: 5555
5252
# Prefix for the imagepull secret created when using private registry
5353
secret_prefix: "private-registry"
54-
# Experimental feature to toggle using kubernetes ingress instead of the Deis router.
54+
# Experimental feature to use Kubernetes ingress instead of Workflow's deis-router.
5555
#
5656
# Valid values are:
57-
# - true: The Deis router will NOT be deployed. Inherently workflow will not be usable until a Kubernetes ingress controller is installed.
58-
# - false: The default mode, and the default behavior of Deis workflow.
57+
# - true: deis-router will not be deployed. Workflow will not be usable until a Kubernetes ingress controller is installed.
58+
# - false: deis-router will be deployed (default).
5959
experimental_native_ingress: false
6060

6161

@@ -113,7 +113,7 @@ controller:
113113
# disabled - turns off open registration
114114
# admin_only - allows for registration by an admin only.
115115
registration_mode: "admin_only"
116-
# The public resolvable hostname to build your cluster with.
116+
# The publicly resolvable hostname to build your cluster with.
117117
#
118118
# This will be the hostname that is used to build endpoints such as "deis.$HOSTNAME"
119119
platform_domain: ""

src/installing-workflow/experimental-native-ingress.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Now that Helm is installed and the repository has been added, install Workflow w
88
$ helm install deis/workflow --namespace deis --set global.experimental_native_ingress=true,controller.platform_domain=deis.com
99
```
1010

11-
Where `global.hostname` is a **required** parameter that is traditionally not required for Workflow. In this example we are using `deis.com` for `$hostname`.
11+
Where `controller.platform_domain` is a **required** parameter that is traditionally not required for Workflow. In this example we are using `deis.com` for `$hostname`.
1212

1313

1414

@@ -19,7 +19,7 @@ Wait for the pods that Helm launched to be ready. Monitor their status by runnin
1919
$ kubectl --namespace=deis get pods
2020
```
2121

22-
You should also notice that a Kubernetes ingress has been installed on your cluster. You can view it by running:
22+
You should also notice that several Kubernetes ingresses has been installed on your cluster. You can view it by running:
2323

2424
```
2525
$ kubectl get ingress --namespace deis
@@ -60,7 +60,7 @@ $ helm install stable/traefik --name deis-ingress-001 --namespace kube-system
6060

6161
The experimental ingress feature requires a user to set up a hostname, and assumes the `deis.$host` convention.
6262

63-
We need to point the `deis.$host` record to the public IP address of your ingress controller. You can get the public IP using the following command.
63+
We need to point the `*.$host` record to the public IP address of your ingress controller. You can get the public IP using the following command. A wildcard entry is necessary here as apps will use the same rule after they are deployed.
6464

6565
```
6666
$ kubectl get svc deis-ingress-001 --namespace kube-system
@@ -78,3 +78,7 @@ If we were using `deis.com` as a hostname we would need to create the following
7878
Once all of the pods are in the `READY` state, and `deis.$host` resolves to the external IP found above Workflow is up an running!
7979

8080
After installing Workflow, [register a user and deploy an application](../quickstart/deploy-an-app.md).
81+
82+
##### Feedback
83+
84+
While this feature is experimental we welcome feedback on the issue. We would like to learn more about use cases, and user experience. Please [open a new issue](https://github.com/deis/workflow/issues/new) for feedback.

src/installing-workflow/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ More rigorous installations would benefit from using outside sources for the fol
3535

3636
#### (Experimental) Kubernetes Native Ingress
3737

38-
Workflow now offers [experimental native ingress](experimental-native-ingress.md) that will allow users to take advantage of native Kubernetes ingress with their cluster. Users will be able to use and define any compatible Kubernetes ingress controller. Feel free to start following along with the [experimental native ingress](experimental-native-ingress.md) guide now.
39-
38+
Workflow now offers [experimental native ingress](experimental-native-ingress.md) to take advantage of native Kubernetes routing. Any compatible Kubernetes ingress controller can be used in place of Workflow's nginx-based deis-router. Follow [this guide](experimental-native-ingress.md) to enable experimental native ingress.
4039
## Add the Deis Chart Repository
4140

4241
The Deis Chart Repository contains everything needed to install Deis Workflow onto a Kubernetes cluster, with a single `helm install deis/workflow --namespace deis` command.

src/quickstart/deploy-an-app.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## Determine your host and hostname values
1+
## Determine Your Host and Hostname Values
22

33
For the rest of this example we will refer to a special variables called `$hostname`. Please choose one of the two methods for building your `$hostname`.
44

55
#### Option 1: Standard Installation
66

7-
For a standard installation you can build the hostname using public IP address and a wildcard DNS solution. Instead of setting up DNS records, this example will use `nip.io`.
7+
For a standard installation that includes deis-router, you can calculate the hostname value using its public IP address and a wildcard DNS record.
88

99
If your router IP is `1.1.1.1`, its `$hostname` will be `1.1.1.1.nip.io`. You can find your IP address by running:
1010

@@ -15,11 +15,11 @@ kubectl --namespace=deis describe svc deis-router
1515
If you do not have an load balancer IP, the router automatically forwards traffic from a kubernetes node to the router. In this case, use the IP of a kubernetes node and the node
1616
port that routes to port 80 on the controller.
1717

18-
Deis requires a wildcard DNS record to dynamically map app names to the router.
18+
Deis workflow requires a wildcard DNS record to dynamically map app names to the router.
1919

2020
#### Option 2: Experimental Native Ingress Installation
2121

22-
In this example, the user should already have DNS set up pointing to their known host. The `$hostname` value can be build by appending `deis.` to the value set in `global.exerpimental_native_ingress`.
22+
In this example, the user should already have DNS set up pointing to their known host. The `$hostname` value can be calculated by prepending `deis.` to the value set in `controller.platform_domain`.
2323

2424
**$hostname**: deis.com
2525

0 commit comments

Comments
 (0)