This repository has been archived by the owner on Feb 27, 2023. It is now read-only.
Docs refresh for Contour 0.6-beta.1. Fixes #171 #184
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Ross Kukulinski <ross@kukulinski.com>
alexbrand
reviewed
Jul 12, 2018
docs/route.md
Outdated
| @@ -1,30 +1,50 @@ | |||
| # Route Specification | |||
|
|
|||
| The core of Gimbal is Routes, which allow traffic into one or more applications. This section will discuss how to utilize Kubernetes `Ingress` objects to create these routes. | |||
| The core of Gimbal is Ingressroutes, which allow traffic to be routed into one or more applications. This section will discuss how to utilize [Contour IngressRoute](https://github.com/heptio/contour/blob/master/docs/ingressroute.md) objects to create these definitions. | |||
There was a problem hiding this comment.
nit: s/Ingressroutes/IngressRoutes
stevesloka
reviewed
Jul 12, 2018
docs/route.md
Outdated
|
|
||
| Before beginning it is important to understand how service discovery functions within Gimbal. The Discoverer components should be deployed per upstream cluster. Once synchronized, services will show up in your team namespace with the cluster name appended. | ||
|
|
||
| For example, if a Kubernetes cluster is being discovered and there was a service named `s1` which existed in the namespace `team1`, in the cluster `node02`, once synchronized the service in the Gimbal cluster would be named `s1-node02`. | ||
| For example, if a Kubernetes cluster is being discovered and there was a service named `s1` which existed in the namespace `team1`, in the cluster `node02`, once synchronized the service in the Gimbal cluster would be named `s1-node02`. |
There was a problem hiding this comment.
Services are: ${backend-name}-${service-name} so I think this example would be: node02-s1
Signed-off-by: Ross Kukulinski <ross@kukulinski.com>
stevesloka
reviewed
Jul 12, 2018
| @@ -1,6 +1,6 @@ | |||
| # Teams with Gimbal | |||
|
|
|||
| A key feature of Gimbal is team management. Teams should be able to configure and define their own Ingress resources within the Gimbal cluster without requiring an administrator to assist. To enable this, users should be allowed access only to specified namespaces in the Gimbal cluster. Within their respective namespaces, team members should be granted specific authorization to create Ingress routes and to view Services and Endpoints. | |||
| A key feature of Gimbal is team management. Teams should be able to configure and define their own IngressRoute resources within the Gimbal cluster without requiring an administrator to assist. To enable this, users should be allowed access only to specified namespaces in the Gimbal cluster. Within their respective namespaces, team members should be granted specific authorization to create IngressRoutes and to view Services and Endpoints. | |||
There was a problem hiding this comment.
Might be good to mention here that teams need Admins to delegate Virtualhosts to them. It was discussed earlier in delegate section.
Signed-off-by: Ross Kukulinski <ross@kukulinski.com>
Signed-off-by: Ross Kukulinski <ross@kukulinski.com>
rosskukulinski
force-pushed
the
beta1-docs
branch
from
4c21af6 to
d266ae3
Compare
stevesloka
reviewed
Jul 12, 2018
docs/route.md
Outdated
|
|
||
| ## Basic Route | ||
| ## Basic Routex |
Signed-off-by: Ross Kukulinski <ross@kukulinski.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Ross Kukulinski ross@kukulinski.com