This repository has been archived by the owner on Mar 24, 2023. It is now read-only.
add the AmazonEKS template function to the amazon_eks and kubectl_apply docs #422
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
areed
approved these changes
Aug 20, 2018
hack/docs/mutations.json
Outdated
| @@ -494,6 +494,7 @@ | |||
| }, | |||
| "merge": { | |||
| "description": "An `amazon_eks` asset generates a terraform file that will create an Amazon EKS Cluster.", | |||
| "extended_description": "It also populates a template function `AmazonEKS` that takes the name of the cluster and returns the path to the generated kubeconfig for the cluster. This path is only valid after the `render` and `terraform` lifecycle steps have run. This is intended to be used within the [kubectl_apply](/api/ship-lifecycle/lifecycle/kubectl_apply/) lifecycle step.}}", | |||
hack/docs/schema.json
Outdated
| @@ -13,6 +13,7 @@ | |||
| "properties": { | |||
| "amazon_eks": { | |||
| "description": "An `amazon_eks` asset generates a terraform file that will create an Amazon EKS Cluster.", | |||
| "extended_description": "It also populates a template function `AmazonEKS` that takes the name of the cluster and returns the path to the generated kubeconfig for the cluster. This path is only valid after the `render` and `terraform` lifecycle steps have run. This is intended to be used within the [kubectl_apply](/api/ship-lifecycle/lifecycle/kubectl_apply/) lifecycle step.}}", | |||
also include that set of template functions in more builders
dexhorthy
reviewed
Aug 20, 2018
| @@ -0,0 +1,6 @@ | |||
| customer_id: "-Am-_6i5pw0u4AbspOwKN4lZUCn49u_G" | |||
There was a problem hiding this comment.
you should consider adding new tests to init_app instead of base, since init_app auto-creates the release in the staging env
There was a problem hiding this comment.
Fair point, I'll move it
areed
approved these changes
Aug 20, 2018
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.
What I Did
Updated the docs for the amazon_eks resource and kubectl_apply lifecycle step to include the "AmazonEKS" template function, fulfilling part of #377.
Added an "extended_description" field to mutations.json which is included in the generated docs but not the page title.
Added an integration test for the "AmazonEKS" template function, fulfilling the other part of #377.
Included the "AmazonEKS" template function set (
ShipContext) anywhere theInstallationContextset was used.closes #377.
How I Did it
How to verify it
The integration test runs successfully and renders the path to the kubeconfig within the inline asset.
Description for the Changelog
Picture of a Boat (not required but encouraged)