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

refactor: rename legacy control plane to standard and update related scripts and docs #1259

Merged
merged 3 commits into from
Jan 23, 2025

Conversation

ritwikranjan
Copy link
Contributor

@ritwikranjan ritwikranjan commented Jan 22, 2025

Description

This pull request includes significant changes to transition from the "legacy" to the "standard" directory and package structure. The changes involve updates to Helm charts, Makefile commands, package imports, and file paths.

Directory and package structure updates:

  • .github/workflows/release-charts.yaml: Updated the Helm package path from legacy to standard.
  • Makefile: Updated multiple Helm install commands to use the standard directory instead of legacy. [1] [2] [3] [4]
  • cmd/root.go: Changed package imports and daemon initialization from legacy to standard. [1] [2]
  • Renamed files from legacy to standard:
    • cmd/legacy/daemon.go to cmd/standard/daemon.go
    • cmd/legacy/daemon_linux.go to cmd/standard/daemon_linux.go
    • cmd/legacy/daemon_windows.go to cmd/standard/daemon_windows.go
  • crd/Makefile: Updated the HELM_CRD_DIR path to use the standard directory.

File deletions and renames:

  • Deleted deploy/legacy/prometheus/retina/create-cm.sh.
  • Renamed deploy/legacy/manifests/controller/helm/retina/templates/NOTES.txt to deploy/standard/manifests/controller/helm/retina/templates/NOTES.txt with updated paths inside the file.

Related Issue

This PR will close #1115

Checklist

  • I have read the contributing documentation.
  • I signed and signed-off the commits (git commit -S -s ...). See this documentation on signing commits.
  • I have correctly attributed the author(s) of the code.
  • I have tested the changes locally.
  • I have followed the project's style guidelines.
  • I have updated the documentation, if necessary.
  • I have added tests, if applicable.

Screenshots (if applicable) or Testing Completed

Please add any relevant screenshots or GIFs to showcase the changes made.

Additional Notes

Add any additional notes or context about the pull request here.


Please refer to the CONTRIBUTING.md file for more information on how to contribute to this project.

@ritwikranjan ritwikranjan requested a review from a team as a code owner January 22, 2025 15:40
apontejaj
apontejaj previously approved these changes Jan 22, 2025
Copy link
Contributor

@kamilprz kamilprz left a comment

Choose a reason for hiding this comment

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

Please use capital lettering in the documentation for consistency

docs/03-Metrics/modes/modes.md Outdated Show resolved Hide resolved
docs/03-Metrics/01-metrics-intro.md Outdated Show resolved Hide resolved
docs/03-Metrics/01-metrics-intro.md Outdated Show resolved Hide resolved
docs/02-Installation/01-Setup.md Outdated Show resolved Hide resolved
docs/02-Installation/01-Setup.md Outdated Show resolved Hide resolved
docs/03-Metrics/01-metrics-intro.md Outdated Show resolved Hide resolved
Made all doc references of the name with S capital in Standard

Co-authored-by: kamilprz <[email protected]>
Signed-off-by: Ritwik Ranjan <[email protected]>
@ritwikranjan ritwikranjan added this pull request to the merge queue Jan 23, 2025
Merged via the queue into microsoft:main with commit c87f650 Jan 23, 2025
27 checks passed
@ritwikranjan ritwikranjan deleted the feat/rename-legacy branch January 23, 2025 14:56
kamilprz added a commit to kamilprz/retina that referenced this pull request Jan 24, 2025
…scripts and docs (microsoft#1259)

# Description

This pull request includes significant changes to transition from the
"legacy" to the "standard" directory and package structure. The changes
involve updates to Helm charts, Makefile commands, package imports, and
file paths.

Directory and package structure updates:

*
[`.github/workflows/release-charts.yaml`](diffhunk://#diff-711012dcc1f315d20ef98e04b14cbc0cb1a388641934c2151ac99f74ff11f62cL43-R43):
Updated the Helm package path from `legacy` to `standard`.
*
[`Makefile`](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L447-R447):
Updated multiple Helm install commands to use the `standard` directory
instead of `legacy`.
[[1]](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L447-R447)
[[2]](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L460-R460)
[[3]](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L477-R477)
[[4]](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L496-R496)
*
[`cmd/root.go`](diffhunk://#diff-ab967ab1a2f3a1b769106eeb7bfe892ef0e81d1d27811fa15be08e6749feee1fL9-R9):
Changed package imports and daemon initialization from `legacy` to
`standard`.
[[1]](diffhunk://#diff-ab967ab1a2f3a1b769106eeb7bfe892ef0e81d1d27811fa15be08e6749feee1fL9-R9)
[[2]](diffhunk://#diff-ab967ab1a2f3a1b769106eeb7bfe892ef0e81d1d27811fa15be08e6749feee1fL31-R31)
* Renamed files from `legacy` to `standard`:
  * `cmd/legacy/daemon.go` to `cmd/standard/daemon.go`
  * `cmd/legacy/daemon_linux.go` to `cmd/standard/daemon_linux.go`
  * `cmd/legacy/daemon_windows.go` to `cmd/standard/daemon_windows.go`
*
[`crd/Makefile`](diffhunk://#diff-414956f6f35c3bc4a93c4c08592ee22397d76d99a1b728e1e33c65075a2a99c8L7-R7):
Updated the `HELM_CRD_DIR` path to use the `standard` directory.

File deletions and renames:

* Deleted `deploy/legacy/prometheus/retina/create-cm.sh`.
* Renamed
`deploy/legacy/manifests/controller/helm/retina/templates/NOTES.txt` to
`deploy/standard/manifests/controller/helm/retina/templates/NOTES.txt`
with updated paths inside the file.

## Related Issue

This PR will close microsoft#1115 

## Checklist

- [x] I have read the [contributing
documentation](https://retina.sh/docs/contributing).
- [x] I signed and signed-off the commits (`git commit -S -s ...`). See
[this
documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
on signing commits.
- [x] I have correctly attributed the author(s) of the code.
- [x] I have tested the changes locally.
- [x] I have followed the project's style guidelines.
- [x] I have updated the documentation, if necessary.
- [x] I have added tests, if applicable.

## Screenshots (if applicable) or Testing Completed

Please add any relevant screenshots or GIFs to showcase the changes
made.

## Additional Notes

Add any additional notes or context about the pull request here.

---

Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more
information on how to contribute to this project.

---------

Signed-off-by: Ritwik Ranjan <[email protected]>
Co-authored-by: kamilprz <[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.

Rename legacy charts to something else
3 participants