Best practices #664
Merged
Best practices #664
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
carolynvs
force-pushed
the
best-practices
branch
from
effb71e
to
cfa7e49
Compare
|
The "sad hack" that I mention in the GKE docs inspired me to make #663. |
Explain how to use porter with minikube and gke
carolynvs
force-pushed
the
best-practices
branch
from
cfa7e49
to
0999fbd
Compare
vdice
approved these changes
Sep 30, 2019
examples/gke-example/README.md
Outdated
|
|
||
| This is a sample Porter bundle that makes use of both the Kubernetes and Exec mixins. The Kubernetes mixin is used to apply Kubernetes manifests to an existing Kubernetes cluster, creating an NGINX deployment and a service. The Kubernetes mixin is also used to produce an output with the value of the service's ClusterIP. After the kubernetes mixin finishes, the `exec` mixin is ued to echo the cluster IP of the service that was created. | ||
|
|
||
| To use this bundle, you will need an existing Kuberentes cluster and a kubeconfig file for use as a credential. |
examples/gke-example/README.md
Outdated
| @@ -0,0 +1,11 @@ | |||
| # Kubernetes + Exec Mixin Example | |||
|
|
|||
| This is a sample Porter bundle that makes use of both the Kubernetes and Exec mixins. The Kubernetes mixin is used to apply Kubernetes manifests to an existing Kubernetes cluster, creating an NGINX deployment and a service. The Kubernetes mixin is also used to produce an output with the value of the service's ClusterIP. After the kubernetes mixin finishes, the `exec` mixin is ued to echo the cluster IP of the service that was created. | |||
There was a problem hiding this comment.
nit: last sentence has lowercase kubernetes as opposed to capitalized precedents -- or perhaps we should quote it a la exec to signify we're referring to the mixin name as used in Porter manifests?
* Fix typo * Use mixin * Use hard line wraps for easier reviews going forward
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this change
This add a best practice section to the docs and kicks it off with two documents and updated examples:
What issue does it fix
Closes #658
Closes #177
Notes for the reviewer
N/A
Checklist