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

Update documentation for curated packages #3683

Merged
merged 1 commit into from
Sep 3, 2024

Conversation

jhaanvi5
Copy link
Member

@jhaanvi5 jhaanvi5 commented Aug 28, 2024

Description of changes:
This PR updates README for curated packages (Prometheus, node-exporter, go-harbor, metallb).

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@eks-distro-bot eks-distro-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 28, 2024
```
Using EKSA CLI

1. Generate local bundle using [generatebundlefile](https://github.com/aws/eks-anywhere-packages/tree/main/generatebundlefile) utility
Copy link
Member

Choose a reason for hiding this comment

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

Do we have specific instructions to run here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes for those steps are provided in README

1. Update the `GIT_TAG` file to have the new desired version based on the upstream release tags.
1. Verify the golang version has not changed.
1. Update the `GIT_TAG` and `GOLANG_VERSION` files to have the new desired version based on the upstream release tags.
1. Review the patches under `patches/` folder and remove any that are either merged upstream or no longer needed.
Copy link
Member

Choose a reason for hiding this comment

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

What if we need to add any? Should we have a pointer on when that might be the case?

Copy link
Member Author

Choose a reason for hiding this comment

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

Some of the cases where we need to add patch for package support are listed here. I have linked this doc in this section in the README

To make changes to the patches folder, follow the steps mentioned [here](https://github.com/aws/eks-anywhere-build-tooling/blob/main/docs/development/packages/update-helm-charts.md#generate-patch-files)

Copy link
Member

@vivek-koppuru vivek-koppuru left a comment

Choose a reason for hiding this comment

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

/approve

@eks-distro-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vivek-koppuru

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@eks-distro-bot eks-distro-bot merged commit 8c79f7c into aws:main Sep 3, 2024
5 checks passed
@aws aws deleted a comment from eks-distro-pr-bot Sep 4, 2024
@aws aws deleted a comment from eks-distro-pr-bot Sep 4, 2024
@@ -1,18 +1,35 @@
![Version](https://img.shields.io/badge/version-v2.53.1-blue)
![Version](https://img.shields.io/badge/version-v2.54.0-blue)
Copy link
Member

Choose a reason for hiding this comment

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

Why are we updating this version here in the README? It is still the old version v2.53.1 in the GIT_TAG file.

Copy link
Member Author

Choose a reason for hiding this comment

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

This was supposed to get merged first
#3671

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved lgtm size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants