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

Commit

Permalink
chore(ingress): Documentation updates from code review
Browse files Browse the repository at this point in the history
Changing documentation per the code review, mostly typos and wordsmithing.

Non breaking change
  • Loading branch information
krisnova authored and mboersma committed Mar 30, 2017
1 parent 9f5bcea commit b8e404c
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 13 deletions.
8 changes: 4 additions & 4 deletions charts/workflow/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,11 @@ global:
host_port: 5555
# Prefix for the imagepull secret created when using private registry
secret_prefix: "private-registry"
# Experimental feature to toggle using kubernetes ingress instead of the Deis router.
# Experimental feature to use Kubernetes ingress instead of Workflow's deis-router.
#
# Valid values are:
# - true: The Deis router will NOT be deployed. Inherently workflow will not be usable until a Kubernetes ingress controller is installed.
# - false: The default mode, and the default behavior of Deis workflow.
# - true: deis-router will not be deployed. Workflow will not be usable until a Kubernetes ingress controller is installed.
# - false: deis-router will be deployed (default).
experimental_native_ingress: false


Expand Down Expand Up @@ -113,7 +113,7 @@ controller:
# disabled - turns off open registration
# admin_only - allows for registration by an admin only.
registration_mode: "admin_only"
# The public resolvable hostname to build your cluster with.
# The publicly resolvable hostname to build your cluster with.
#
# This will be the hostname that is used to build endpoints such as "deis.$HOSTNAME"
platform_domain: ""
Expand Down
10 changes: 7 additions & 3 deletions src/installing-workflow/experimental-native-ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Now that Helm is installed and the repository has been added, install Workflow w
$ helm install deis/workflow --namespace deis --set global.experimental_native_ingress=true,controller.platform_domain=deis.com
```

Where `global.hostname` is a **required** parameter that is traditionally not required for Workflow. In this example we are using `deis.com` for `$hostname`.
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`.



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

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

```
$ kubectl get ingress --namespace deis
Expand Down Expand Up @@ -60,7 +60,7 @@ $ helm install stable/traefik --name deis-ingress-001 --namespace kube-system

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

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.
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.

```
$ kubectl get svc deis-ingress-001 --namespace kube-system
Expand All @@ -78,3 +78,7 @@ If we were using `deis.com` as a hostname we would need to create the following
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!

After installing Workflow, [register a user and deploy an application](../quickstart/deploy-an-app.md).

##### Feedback

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.
3 changes: 1 addition & 2 deletions src/installing-workflow/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@ More rigorous installations would benefit from using outside sources for the fol

#### (Experimental) Kubernetes Native Ingress

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.

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.
## Add the Deis Chart Repository

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.
Expand Down
8 changes: 4 additions & 4 deletions src/quickstart/deploy-an-app.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Determine your host and hostname values
## Determine Your Host and Hostname Values

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`.

#### Option 1: Standard Installation

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`.
For a standard installation that includes deis-router, you can calculate the hostname value using its public IP address and a wildcard DNS record.

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:

Expand All @@ -15,11 +15,11 @@ kubectl --namespace=deis describe svc deis-router
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
port that routes to port 80 on the controller.

Deis requires a wildcard DNS record to dynamically map app names to the router.
Deis workflow requires a wildcard DNS record to dynamically map app names to the router.

#### Option 2: Experimental Native Ingress Installation

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`.
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`.

**$hostname**: deis.com

Expand Down

0 comments on commit b8e404c

Please sign in to comment.