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

readme: remember to edit the github release before publishing #548

Merged
merged 1 commit into from
Jul 12, 2024

Conversation

maelvls
Copy link
Member

@maelvls maelvls commented Jul 11, 2024

I've also re-structured the README so that everything that talks about tiers is its own section. It should be much clearer now to what images and helm charts each customer has access to.

I've also re-structured the README so that everything that talks
about tiers is its own section. It should be much clearer now to
what images and helm charts each customer has access to.
@maelvls
Copy link
Member Author

maelvls commented Jul 11, 2024

Can you review this @wallrj? I changed a bit the documentation you had written a year ago.

@maelvls maelvls requested a review from wallrj July 11, 2024 13:38
@maelvls
Copy link
Member Author

maelvls commented Jul 11, 2024

Unrelated: I think we should also check the presence of the images after releasing. Just to double check. Do you think this check should be part as the release process @wallrj?


To check that the automation went through, check that the 3 public images are available:

docker run -it quay.io/jetstack/preflight:v0.1.49 version
docker run -it quay.io/jetstack/venafi-agent:v0.1.49 version
docker run -it registry.venafi.cloud/venafi-agent/venafi-agent:v0.1.49 version

Then, you will need to use venctl to check the two private registries:

  1. curl -sSfL https://dl.venafi.cloud/venctl/latest/installer.sh | bash
    
  2. Go to https://ven-tlspk.venafi.cloud/platform-settings/user-preferences?key=api-keys. Log in using the username [email protected] and the password here). Copy the API key for the next step (click "Generate" if the API key doesn't already exist).

  3. Set the APIKEY env variable:

    APIKEY=...
    
  4. Docker login to private-registry.venafi.cloud:

    venctl iam service-account registry create --name "$USER Temp" \
      --vcp-region US \
      --output dockerconfig \
      --output-file dockerconfig \
      --api-key $APIKEY
    docker login private-registry.venafi.cloud \
      | --username $(cat dockerconfig | jq '.. | select(.username?).username' -r) \
      | --password $(cat dockerconfig | jq '.. | select(.username?).auth            | @base64d' -r | cut -d: -f2) |
  5. Go to https://ven-tlspk-eu.venafi.cloud/platform-settings/user-preferences?key=api-keys. Log in using the username [email protected] and the password here). Click "Generate" and copy the API key for the next step.

  6. Set the APIKEY env variable:

    APIKEY=...
    
  7. Docker login to private-registry.venafi.eu:

    venctl iam service-account registry create --name "$USER Temp" \
      --vcp-region EU \
      --output dockerconfig \
      --output-file dockerconfig \
      --api-key $APIKEY
    docker login private-registry.venafi.eu \
      | --username $(cat dockerconfig | jq '.. | select(.username?).username' -r) \
      | --password $(cat dockerconfig | jq '.. | select(.username?).auth            | @base64d' -r | cut -d: -f2) |

And now:

docker run -it private-registry.venafi.cloud/venafi-agent/venafi-agent:v0.1.49 version
docker run -it private-registry.venafi.eu/venafi-agent/venafi-agent:v0.1.49 version

Copy link
Member

@wallrj wallrj left a comment

Choose a reason for hiding this comment

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

Thanks @maelvls, for bringing the release process docs up to date.

/lgtm

| `oci://private-registry.venafi.cloud/charts/venafi-kubernetes-agent` | Private | Tier 2 of Venafi TLS Protect for Kubernetes | |
| `oci://private-registry.venafi.eu/charts/venafi-kubernetes-agent` | Private | Tier 2 of Venafi TLS Protect for Kubernetes | |


Copy link
Member

Choose a reason for hiding this comment

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

Thanks for doing this and for linking to the docs.

- Use the title "v0.1.49",
- Click "Generate Release Notes"
- Edit the release notes to make them readable to the end-user.
- Click "Publish" (don't select "Draft")
Copy link
Member

Choose a reason for hiding this comment

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

Thanks. When I wrote these notes originally I either overlooked the creation of a "Release" page (with release-notes) or else that wasn't a convention at the time.
My release at that time must only have resulted in a tag in GitHub which is not helpful for users.

I note that there will only be GitHub release pages for the venafi-kubernetes-agent chart not the jetstack-secure chart, but that's OK since jetstack-secure is considered EOL.


> [!WARNING]
>
> Don't worry about the "signing" pipeline job failing. It hasn't be working for a while. It should be removed as we don't need the provenance steps anymore. We are now signing our image during the replication of the OCI images to Harbor using the Venafi keys.
Copy link
Member

Choose a reason for hiding this comment

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

This is a embarrassing. Remember to remove this when we eventually fix that problem.

@wallrj
Copy link
Member

wallrj commented Jul 12, 2024

Unrelated: I think we should also check the presence of the images after releasing. Just to double check. Do you think this check should be part as the release process @wallrj?

@maelvls I turned that into a followup issue.

@maelvls maelvls merged commit 473277b into master Jul 12, 2024
8 checks passed
@wallrj wallrj deleted the improve-release-docs branch July 12, 2024 13:51
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.

2 participants