-
Notifications
You must be signed in to change notification settings - Fork 25
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
Provide an example uds-bundle.yaml
that uses functional layers
#868
Labels
documentation
Improvements or additions to documentation
Comments
As long as this ends up only in the docs and not an actual example we publish it's probably fine. Functional layers are intended for internal use and should not typically be used in production environments, unless by exception. |
5 tasks
UnicornChance
pushed a commit
that referenced
this issue
Oct 11, 2024
…896) ## Description Changes included: 1. Functional layers upgrade was not successful when I tested initially. There were ownership issues with the `manifests` we use for istio. To resolve that problem I moved the manifests into a chart and added an action to update the ownership before the upgrade. I also removed the pepr action that we have had for several releases since it was needed as a one-time upgrade step (similar to this one). 2. Added a lightweight doc on the usage of functional layers with a very brief explanation and warning as well as a full example of a bundle pulling in the layers. 3. A few misc link fixes and other things to follow the astro docs switch. ## Related Issue Fixes #868 Fixes #900 ## Type of change - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Other (security config, docs update, etc) ## Checklist before merging - [x] Test, docs, adr added or updated as needed - [x] [Contributor Guide](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md) followed --------- Co-authored-by: Noah <40781376+noahpb@users.noreply.github.com>
docandrew
pushed a commit
that referenced
this issue
Oct 17, 2024
…896) ## Description Changes included: 1. Functional layers upgrade was not successful when I tested initially. There were ownership issues with the `manifests` we use for istio. To resolve that problem I moved the manifests into a chart and added an action to update the ownership before the upgrade. I also removed the pepr action that we have had for several releases since it was needed as a one-time upgrade step (similar to this one). 2. Added a lightweight doc on the usage of functional layers with a very brief explanation and warning as well as a full example of a bundle pulling in the layers. 3. A few misc link fixes and other things to follow the astro docs switch. ## Related Issue Fixes #868 Fixes #900 ## Type of change - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Other (security config, docs update, etc) ## Checklist before merging - [x] Test, docs, adr added or updated as needed - [x] [Contributor Guide](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md) followed --------- Co-authored-by: Noah <40781376+noahpb@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
With the introduction of functional layers, we should provide an example configuration with best practices for end users to reference. A starting point can be found at
bundles/k3d-slim-dev/uds-bundle.yaml
. A proper example should include:The example configuration should not demonstrate all variations of which layers can be referenced in a bundle, rather, it should serve as a starting point for consumers looking to use functional layers.
The text was updated successfully, but these errors were encountered: