-
Notifications
You must be signed in to change notification settings - Fork 273
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add k8s Deploy action example with shared manifests #4992
Conversation
82a08bc
to
53cf3ab
Compare
I have now tested this locally to confirm everything runs and is accessible. I see this as part of a larger initiative to directly address needs in our docs. Currently we suggest the E.g. a docs page, even a Seed, that walks users through generating shared manifests. This could even be turned into a native Your PR mentions,
Your first bullet sounds like something we should support in For your |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See comment above 👀
Absolutely, it is. I just started with the examples because they had been requested. But the overall goal is to update the docs and reference the examples from there.
Yes, we do but they're stale. My plan was to open a new one with up to date context.
I feel quite strongly that we should support this. The current workaround is to hoist everything to the top which is not nice.
Will do. |
57e86c5
to
93f0f96
Compare
@worldofgeese, I added a new commit addressing your comments. |
This commit adds an example that uses the `kubernetes` deploy action and shares the same manifests between a couple of actions. This is achieved by using Garden template strings in the manifests. The example is a three tier web app version of the vote example with "web", "API", and "DB" components that I think we should consider using by default. It's not as complex as the main vote example which tends to draw attention away from the functionality being demonstrated, and not as trivial as the basic "demo-project". Three tier web apps are also a common pattern that a lot of people will be familiar with. And lastly, this is also the same example we use in the "How Garden Works" video series so it will become familiar to users eventually.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! 🥇
Instead of hoisting the Garden config to the root, we leave it in the service directories and overwrite the source path.
93f0f96
to
9e498fe
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great shot of clarity and taught me a new key to use for rewriting source path ⚡
What this PR does / why we need it:
From the commit message:
This commit adds an example that uses the
kubernetes
deploy action and shares the same manifests between a couple of actions. This is achieved by using Garden template strings in the manifests.The example is a three tier web app version of the vote example with "web", "API", and "DB" components that I think we should consider using by default.
It's not as complex as the main vote example which tends to draw attention away from the functionality being demonstrated, and not as trivial as the basic "demo-project".
Three tier web apps are also a common pattern that a lot of people will be familiar with.
And lastly, this is also the same example we use in the "How Garden Works" video series so it will become familiar to users eventually.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Added this example following the conversation here: #4729
We'll also be adding actual docs on the topic, this example is just the first step and can be used as a reference in those docs.