From bd8f528b111c01cb097d38da2875a9b0bfb5d266 Mon Sep 17 00:00:00 2001 From: Gurney Buchanan Date: Mon, 3 Jun 2024 16:45:43 -0400 Subject: [PATCH 1/2] Add documentation on manually triggering a ReleasePlan --- ...oc_manually_triggering_a_release_plan.adoc | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 docs/modules/ROOT/pages/how-to-guides/proc_manually_triggering_a_release_plan.adoc diff --git a/docs/modules/ROOT/pages/how-to-guides/proc_manually_triggering_a_release_plan.adoc b/docs/modules/ROOT/pages/how-to-guides/proc_manually_triggering_a_release_plan.adoc new file mode 100644 index 00000000..507c53dd --- /dev/null +++ b/docs/modules/ROOT/pages/how-to-guides/proc_manually_triggering_a_release_plan.adoc @@ -0,0 +1,56 @@ += Manually Triggering a ReleasePlan + +This document covers the process to manually trigger a ReleasePlan for a given Snapshot of an Application when using Konflux. Common use cases include re-releasing a snapshot that failed to release due to a now-resolved condition or in the case that a ReleasePlan is not automatically triggered on every Snapshot intentionally to enforce manual releases (see: Releases to Production Registries that happen infrequently). + +.*Prerequisites* + +* A Konflux workspace with an Application with complete Snapshots, a valid ReleasePlan, and a valid ReleasePlanAdmission +* CLI Access to the Konflux Instance and Namespace that houses the Application and resources +* A minimum of Maintainer access to the Workspace/Namespace that houses the Application and ReleasePlan +* [Optional] Contributor (Viewer) access to the Release Engineering namespace that houses the ReleasePlanAdmission for the Application in question + +.*Procedures* + +. Create a `Release.yaml` object locally + ++ +*Example `Release.yaml` object* + ++ +[source,yaml] +---- +apiVersion: appstudio.redhat.com/v1alpha1 +kind: Release +metadata: + annotations: + pac.test.appstudio.openshift.io/event-type: push + name: -manual-release- <.> + namespace: <.> +spec: + gracePeriodDays: 7 <.> + releasePlan: <.> + snapshot: <.> +---- + ++ +<.> The name of the release object - set to something identifiable and unique. +<.> The namespace that houses the Application you're planning to release. +<.> The number of days the Release object should be preserved. +<.> The name of the ReleasePlan that should be used. +<.> The name of the Snapshot to Release. + +. In the development workspace, apply the `Release.yaml` file and add the resource to your cluster by running the following command: + ++ +[source,shell] +---- +$ oc apply -f Release.yaml +---- + +.*Verification* + +. On the Trusted Application Pipeline console, select the *Release* tab under the Application. +. You should see a Release object matching the name you configured. If you have access to the Release Engineering namespace, you should be able to see the PipelineRun for the Release. + +.Next steps +link:https://redhat-appstudio.github.io/docs.appstudio.io/Documentation/main/how-to-guides/proc_managed_services_onboarding.adoc/[Managed services team onboarding] \ No newline at end of file From 77e5a6d87b081f0c8f58d0eeb4d208ac0bdb8436 Mon Sep 17 00:00:00 2001 From: Gurney Buchanan Date: Mon, 3 Jun 2024 16:49:49 -0400 Subject: [PATCH 2/2] Update navigation --- docs/modules/ROOT/nav-how-to-guides.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/modules/ROOT/nav-how-to-guides.adoc b/docs/modules/ROOT/nav-how-to-guides.adoc index 639f7ed2..dbf8e3a3 100644 --- a/docs/modules/ROOT/nav-how-to-guides.adoc +++ b/docs/modules/ROOT/nav-how-to-guides.adoc @@ -31,6 +31,7 @@ ** xref:how-to-guides/proc_managing-compliance-with-the-enterprise-contract.adoc[Managing compliance with the Enterprise Contract] ** xref:how-to-guides/con_release_application.adoc[Releasing an application] *** xref:how-to-guides/proc_release_plan.adoc[Creating a `releasePlan` object] +*** xref:how-to-guides/proc_manually_triggering_a_release_plan.adoc[Manually Releasing a Snapshot] ** xref:how-to-guides/proc_managed_services_onboarding.adoc[Managed services team onboarding] ** xref:how-to-guides/proc_delete_application.adoc[Deleting an application] ** xref:how-to-guides/proc_multiversion.adoc[Managing multiple software versions]