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

Add note to the example of Manifest Deployer #5482

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

pepsi1k
Copy link

@pepsi1k pepsi1k commented Jan 28, 2025

Description

It’s unclear that the applier-manager picks up only files with the .yaml file type.

Fixes: #5481

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Manual test
  • Auto test added

Checklist:

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

It’s unclear that the applier-manager picks up only files with the `.yaml` file type.

Fixes: k0sproject#5481

Signed-off-by: Bohdan Kanivchenko <[email protected]>
@pepsi1k pepsi1k requested review from a team as code owners January 28, 2025 20:51
Copy link
Contributor

@juanluisvaladas juanluisvaladas left a comment

Choose a reason for hiding this comment

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

Hi @pepsi1k, thanks for the contribution!

I think this is something we should document but not in the example section. I'd write it in the overview section... Maybe something like:

By default, k0s reads all manifest files under /var/lib/k0s/manifests that end with .yaml and ensures that their state matches the cluster state. It does not read files with other extensions, such as .yml. Moreover, on removal of a manifest file, k0s will automatically prune all of its associated resources.

Not necessarily exactly this, but somewhere around the overview section.

This reverts commit 104524e.

Signed-off-by: Bohdan Kanivchenko <[email protected]>
Add a more complete explanation about file types that can be synchronized

Fixes: k0sproject#5481

Signed-off-by: Bohdan Kanivchenko <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Manifest Deployer doesn't work
2 participants