Skip to content
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 documentation for keptn.sh/container annotation #2500

Merged
merged 11 commits into from
Nov 16, 2023

Conversation

norman-zon
Copy link
Contributor

Summary

If a pod contains multiple containers the user can select which container the version should be extracted from by setting the keptn.sh/container annotation. If the annotation is set, but no container matches its name we assume something is wrong an throw an error.

Fixes #2484

Checks

  • My PR fulfills the Definition of Done of the corresponding issue and not more (or parts if the issue is separated
    into multiple PRs)
  • I used descriptive commit messages to help reviewers understand my thought process
  • I signed off all my commits according to the Developer Certificate of Origin (DCO)(
    see Contribution Guide)
  • My PR title is formatted according to the semantic PR conventions described in
    the Contribution Guide
  • My content follows the style guidelines of this project (YAMLLint, markdown-lint)
  • I regenerated the auto-generated docs for Helm and the CRD documentation (if applicable)
  • I have performed a self-review of my content including grammar and typo errors and also checked the rendered page
    from the Netlify deploy preview
  • My changes result in all-green PR checks (first-time contributors need to ask a maintainer to approve their test runs)

Signed-off-by: Norman <85173861+norman-zon@users.noreply.github.com>
@norman-zon norman-zon requested review from a team as code owners November 14, 2023 13:57
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 14, 2023
Copy link

netlify bot commented Nov 14, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 97bc1a8
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/6554e1ddb301100008c67231
😎 Deploy Preview https://deploy-preview-2500--keptn-lifecycle-toolkit.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@norman-zon
Copy link
Contributor Author

@mowies , I am not too sure about appending the container annotation to the list, because there is no app.kubernetes.io/ equivalent. But it still seems to be the best place to put it for visibility

StackScribe
StackScribe previously approved these changes Nov 15, 2023
Copy link
Contributor

@StackScribe StackScribe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done! I left a couple small editorial suggestions but otherwise, this is ready to go!

docs/content/en/docs/implementing/integrate.md Outdated Show resolved Hide resolved
docs/content/en/docs/implementing/integrate.md Outdated Show resolved Hide resolved
Copy link
Member

@thisthat thisthat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some comments to make the lint checks for MD files passing :)
Otherwise, LGTM content-wise :)

docs/content/en/docs/implementing/integrate.md Outdated Show resolved Hide resolved
docs/content/en/docs/implementing/integrate.md Outdated Show resolved Hide resolved
mowies and others added 3 commits November 15, 2023 09:23
Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
norman-zon and others added 4 commits November 15, 2023 16:20
Co-authored-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Norman <85173861+norman-zon@users.noreply.github.com>
Co-authored-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: Norman <85173861+norman-zon@users.noreply.github.com>
Co-authored-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Norman <85173861+norman-zon@users.noreply.github.com>
Copy link

sonarcloud bot commented Nov 15, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@thisthat thisthat merged commit 0578587 into keptn:main Nov 16, 2023
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for multi container auto-gen app use case
5 participants