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

add activation keys docs #187

Merged
merged 6 commits into from
Dec 4, 2024
Merged

Conversation

brianwcook
Copy link
Contributor

No description provided.

Copy link

github-actions bot commented Dec 3, 2024

🚀 Preview is available at https://pr-187--konflux-docs.netlify.app

Copy link

github-actions bot commented Dec 3, 2024

🚀 Preview is available at https://pr-187--konflux-docs.netlify.app

Alternatively, you can create the secret through the CLI. After logging into your cluster and navigating to your namespace, run the following command:

----
kubectl create secret generic activation-key -n <your-tenant> --from-literal=org=<your org id> --from-literal=activationkey=<your activation key name>
Copy link
Member

Choose a reason for hiding this comment

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

This will make activation keys "just work" because of the default value of the parameter, correct? Would it be better if we suggested that an activation key is created with a unique name and require users to explicitly set the parameter (I guess they would need to set it on the pipelinerun, pipeline, and the task so that it is properly passed)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added a new section to explain how naming impacts the scope of the key


=== Automatic registration

The buildah task will use a provided activation key to register itself with Red Hat subscription manager and moount the necessary credentials so that can be used by the builds.
Copy link
Member

Choose a reason for hiding this comment

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

If we use suggest the default activation key, can we inform users how to override the parameter so that a configured activation key isn't used everywhere?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

instead, I added a section advising the user to not use the default name unless they want the key to be used for all builds in the workspace. The pattern of adding a "dummy name" pointing to a non-existent key does work, but I think it seems like a weird thing to instruct people to do

Copy link

github-actions bot commented Dec 3, 2024

🚀 Preview is available at https://pr-187--konflux-docs.netlify.app

@brianwcook brianwcook merged commit 4b4843f into konflux-ci:main Dec 4, 2024
2 checks passed
@brianwcook brianwcook deleted the activation-keys branch December 6, 2024 21:07
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