From 9d00409ee46966f434ec0247c6d85031048c8f53 Mon Sep 17 00:00:00 2001 From: mkosiarc Date: Tue, 25 Jun 2024 07:26:25 +0200 Subject: [PATCH] Document how to create entitlement subscription secret KFLUXBUGS-1326 Signed-off-by: mkosiarc --- docs/modules/ROOT/nav-how-to-guides.adoc | 1 + .../proc_entitlement_subscription.adoc | 32 +++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 docs/modules/ROOT/pages/how-to-guides/configuring-builds/proc_entitlement_subscription.adoc diff --git a/docs/modules/ROOT/nav-how-to-guides.adoc b/docs/modules/ROOT/nav-how-to-guides.adoc index 639f7ed2..ed6d5b1d 100644 --- a/docs/modules/ROOT/nav-how-to-guides.adoc +++ b/docs/modules/ROOT/nav-how-to-guides.adoc @@ -10,6 +10,7 @@ *** xref:how-to-guides/configuring-builds/proc_defining_component_relationships.adoc[Defining component relationships] *** xref:how-to-guides/configuring-builds/proc_preventing_redundant_rebuilds.adoc[Preventing redundant rebuilds] *** xref:how-to-guides/configuring-builds/proc_custom-tags.adoc[Using custom tags] +*** xref:how-to-guides/configuring-builds/proc_entitlement_subscription.adoc[Using Red Hat entitlement subscription] ** Testing your application *** xref:how-to-guides/testing_applications/con_test-overview.adoc[Overview of {ProductName} tests] *** xref:how-to-guides/testing_applications/surface-level_tests.adoc[Surface-level tests] diff --git a/docs/modules/ROOT/pages/how-to-guides/configuring-builds/proc_entitlement_subscription.adoc b/docs/modules/ROOT/pages/how-to-guides/configuring-builds/proc_entitlement_subscription.adoc new file mode 100644 index 00000000..d4fa61e4 --- /dev/null +++ b/docs/modules/ROOT/pages/how-to-guides/configuring-builds/proc_entitlement_subscription.adoc @@ -0,0 +1,32 @@ +:_content-type: PROCEDURE +:troubleshooting_builds: + +[id="entitlement_subscription_{context}"] += Using Red Hat entitlement subscription + +Entitlement subscription allows users to install RPMs that are not accessible without it. In order to use it in your builds, you must have access to an entitlement subscription +and possess the neccessary entitlement certificate files. To obtain them, review https://developers.redhat.com/articles/2022/01/24/create-entitled-builds-red-hat-subscriptions-openshift[Subscription benefits for secure deployments] guide. + +Once you have the *.pem* and *-key.pem* files, you will need to create a secret in your Konflux namespace. You can do it in two ways: + +. <> +. <> + + +[[Create-entitlement-secret-through-the-UI]] +== Create entitlement secret through the UI + +1. Access the Secrets section in the konflux UI and click on *Add secret*. +2. Set the secret name to *etc-pki-entitlement*. +3. Add the first key with the name *-key.pem* and and set the value to the contents of the key file. +4. Add a second key with the name *.pem* and set the value to the contents of the certificate file. +5. Save the secret by clicking *Add secret* + +[[Create-entitlement-secret-through-console]] +== Create entitlement secret through console + +Alternatively, you can create the secret through the CLI. After logging into your cluster and navigating to your namespace, run the following command: + +---- +oc create secret generic etc-pki-entitlement -n --from-file -key.pem --from-file .pem +---- \ No newline at end of file