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.

Sign up for GitHub

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

Jump to bottom

chore: handle upgrade path for functional layers, add doc for usage #896

Merged
merged 7 commits into from
Oct 11, 2024
Merged

chore: handle upgrade path for functional layers, add doc for usage #896

merged 7 commits into from
Oct 11, 2024

Conversation

mjnagel
Copy link
Contributor

@mjnagel mjnagel commented Oct 10, 2024 •
edited
Loading

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

@mjnagel mjnagel self-assigned this Oct 10, 2024
@mjnagel
Copy link
Contributor Author

mjnagel commented Oct 10, 2024

Tentatively moving this into review, but would benefit from @pauldipietro's thoughts/awareness on this as we are in the middle of moving docs around.

@mjnagel mjnagel marked this pull request as ready for review October 10, 2024 17:45
@mjnagel mjnagel requested a review from a team as a code owner October 10, 2024 17:45
@mjnagel mjnagel changed the title chore: fix upgrade path for functional layers, add doc for usage chore: handle upgrade path for functional layers, add doc for usage Oct 10, 2024
@mjnagel @noahpb
Update docs/deployment/functional-layers.md
e206857 
Co-authored-by: Noah <40781376+noahpb@users.noreply.github.com>
UnicornChance
UnicornChance previously approved these changes Oct 10, 2024
View reviewed changes
@noahpb
Copy link
Contributor

noahpb commented Oct 11, 2024

While it's implied in the ADR, is it worth calling out somewhere that we recommend pulling layers at the same version?

@mjnagel
Copy link
Contributor Author

mjnagel commented Oct 11, 2024

Yeah good callout @noahpb - will update when I rebase this.

@mjnagel mjnagel mentioned this pull request Oct 11, 2024
Closed
@mjnagel mjnagel merged commit 70d6b1b into main Oct 11, 2024
26 checks passed
@mjnagel mjnagel deleted the func-layer-doc branch October 11, 2024 20:24
@github-actions github-actions bot mentioned this pull request Oct 11, 2024
Merged
UnicornChance pushed a commit that referenced this pull request Oct 11, 2024
@mjnagel @noahpb @UnicornChance
chore: handle upgrade path for functional layers, add doc for usage (#…
5197d33 
…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>
mjnagel pushed a commit that referenced this pull request Oct 11, 2024
@github-actions
chore(main): release 0.29.0 (#842)
f42e93c 
🤖 I have created a release *beep* *boop*
---


##
[0.29.0](v0.28.0...v0.29.0)
(2024-10-11)


### Features

* add base and identity layers
([#853](#853))
([b3f532a](b3f532a))
* add logging functional layer
([#861](#861))
([c1a67b9](c1a67b9))
* add metrics-server functional layer
([#865](#865))
([290367a](290367a))
* add monitoring layer
([#872](#872))
([5ecb040](5ecb040))
* add nightly testing for rke2
([#808](#808))
([c401419](c401419))
* add service accounts options to sso
([#852](#852))
([1029162](1029162))
* backup and restore layer, ui layer, runtime security layer
([#862](#862))
([b1d8015](b1d8015))
* grafana-ha
([#838](#838))
([d532d76](d532d76))


### Bug Fixes

* broken readme link
([#899](#899))
([6e47b11](6e47b11))
* **ci:** switch to larger runners to resolve ci disk space issues
([#882](#882))
([1af0401](1af0401))
* snapshot ci version modification and tasks for publish
([#877](#877))
([f01e5bd](f01e5bd))
* support for anywhere network policies in cilium
([#884](#884))
([5df0737](5df0737))


### Miscellaneous

* cleanup license parsing for github
([#881](#881))
([43c98ce](43c98ce))
* **deps:** update chainctl action to v0.2.3
([#864](#864))
([d782b59](d782b59))
* **deps:** update checkout action to v4.2.0
([#825](#825))
([29d1c98](29d1c98))
* **deps:** update dependency defenseunicorns/lula to v0.8.0
([#841](#841))
([fe36150](fe36150))
* **deps:** update githubactions
([#866](#866))
([44f8ea5](44f8ea5))
* **deps:** update grafana to 11.2.1
([#836](#836))
([11383c1](11383c1))
* **deps:** update grafana to v11.2.2
([#867](#867))
([06ed2c3](06ed2c3))
* **deps:** update loki nginx image to v1.27.2
([#894](#894))
([df7d427](df7d427))
* **deps:** update loki to v3.2.0
([#791](#791))
([d3c60b5](d3c60b5))
* **deps:** update metrics-server chart to v3.12.2
([#873](#873))
([e2e61ce](e2e61ce))
* **deps:** update pepr to v0.37.1
([#843](#843))
([68abcb2](68abcb2))
* **deps:** update pepr to v0.37.2
([#850](#850))
([b51f659](b51f659))
* **deps:** update prometheus operator to 0.77.1
([#819](#819))
([0864b33](0864b33))
* **deps:** update prometheus-stack
([#855](#855))
([c791c24](c791c24))
* **deps:** update prometheus-stack helm-charts to v64.0.0
([#849](#849))
([50a2588](50a2588))
* **deps:** update runtime to v0.6.0
([#897](#897))
([89ae6e2](89ae6e2))
* **deps:** update support-deps
([#890](#890))
([26ea612](26ea612))
* **deps:** update test-infra
([#875](#875))
([583f07c](583f07c))
* **deps:** update test-infra to v6.9.0
([#848](#848))
([ef9d317](ef9d317))
* **deps:** update uds to v0.17.0
([#859](#859))
([1489fef](1489fef))
* **deps:** update zarf to v0.41.0
([#857](#857))
([a390c3d](a390c3d))
* **docs:** update doc structure for site refresh
([#895](#895))
([1946a9a](1946a9a))
* fix broken link in docs
([#845](#845))
([3078a5b](3078a5b))
* fix license header references
([#901](#901))
([cf38b82](cf38b82))
* handle upgrade path for functional layers, add doc for usage
([#896](#896))
([70d6b1b](70d6b1b))
* regroup 'support dependencies' in renovate config
([#885](#885))
([640d859](640d859))
* update license
([#878](#878))
([b086170](b086170))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
docandrew pushed a commit that referenced this pull request Oct 17, 2024
@mjnagel @noahpb @docandrew
chore: handle upgrade path for functional layers, add doc for usage (#…
22c6ae4 
…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 pull request Oct 17, 2024
@github-actions @docandrew
chore(main): release 0.29.0 (#842)
e7cbfc2 
🤖 I have created a release *beep* *boop*
---


##
[0.29.0](v0.28.0...v0.29.0)
(2024-10-11)


### Features

* add base and identity layers
([#853](#853))
([b3f532a](b3f532a))
* add logging functional layer
([#861](#861))
([c1a67b9](c1a67b9))
* add metrics-server functional layer
([#865](#865))
([290367a](290367a))
* add monitoring layer
([#872](#872))
([5ecb040](5ecb040))
* add nightly testing for rke2
([#808](#808))
([c401419](c401419))
* add service accounts options to sso
([#852](#852))
([1029162](1029162))
* backup and restore layer, ui layer, runtime security layer
([#862](#862))
([b1d8015](b1d8015))
* grafana-ha
([#838](#838))
([d532d76](d532d76))


### Bug Fixes

* broken readme link
([#899](#899))
([6e47b11](6e47b11))
* **ci:** switch to larger runners to resolve ci disk space issues
([#882](#882))
([1af0401](1af0401))
* snapshot ci version modification and tasks for publish
([#877](#877))
([f01e5bd](f01e5bd))
* support for anywhere network policies in cilium
([#884](#884))
([5df0737](5df0737))


### Miscellaneous

* cleanup license parsing for github
([#881](#881))
([43c98ce](43c98ce))
* **deps:** update chainctl action to v0.2.3
([#864](#864))
([d782b59](d782b59))
* **deps:** update checkout action to v4.2.0
([#825](#825))
([29d1c98](29d1c98))
* **deps:** update dependency defenseunicorns/lula to v0.8.0
([#841](#841))
([fe36150](fe36150))
* **deps:** update githubactions
([#866](#866))
([44f8ea5](44f8ea5))
* **deps:** update grafana to 11.2.1
([#836](#836))
([11383c1](11383c1))
* **deps:** update grafana to v11.2.2
([#867](#867))
([06ed2c3](06ed2c3))
* **deps:** update loki nginx image to v1.27.2
([#894](#894))
([df7d427](df7d427))
* **deps:** update loki to v3.2.0
([#791](#791))
([d3c60b5](d3c60b5))
* **deps:** update metrics-server chart to v3.12.2
([#873](#873))
([e2e61ce](e2e61ce))
* **deps:** update pepr to v0.37.1
([#843](#843))
([68abcb2](68abcb2))
* **deps:** update pepr to v0.37.2
([#850](#850))
([b51f659](b51f659))
* **deps:** update prometheus operator to 0.77.1
([#819](#819))
([0864b33](0864b33))
* **deps:** update prometheus-stack
([#855](#855))
([c791c24](c791c24))
* **deps:** update prometheus-stack helm-charts to v64.0.0
([#849](#849))
([50a2588](50a2588))
* **deps:** update runtime to v0.6.0
([#897](#897))
([89ae6e2](89ae6e2))
* **deps:** update support-deps
([#890](#890))
([26ea612](26ea612))
* **deps:** update test-infra
([#875](#875))
([583f07c](583f07c))
* **deps:** update test-infra to v6.9.0
([#848](#848))
([ef9d317](ef9d317))
* **deps:** update uds to v0.17.0
([#859](#859))
([1489fef](1489fef))
* **deps:** update zarf to v0.41.0
([#857](#857))
([a390c3d](a390c3d))
* **docs:** update doc structure for site refresh
([#895](#895))
([1946a9a](1946a9a))
* fix broken link in docs
([#845](#845))
([3078a5b](3078a5b))
* fix license header references
([#901](#901))
([cf38b82](cf38b82))
* handle upgrade path for functional layers, add doc for usage
([#896](#896))
([70d6b1b](70d6b1b))
* regroup 'support dependencies' in renovate config
([#885](#885))
([640d859](640d859))
* update license
([#878](#878))
([b086170](b086170))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@UnicornChance UnicornChance UnicornChance approved these changes

@noahpb noahpb noahpb approved these changes

Assignees

@mjnagel mjnagel

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

bad link in uds-deploy documentation Provide an example uds-bundle.yaml that uses functional layers
3 participants
@mjnagel @noahpb @UnicornChance