From f055533219b25457effedc9d0daf88a15681bab3 Mon Sep 17 00:00:00 2001 From: Venkatesh S Date: Mon, 26 Jun 2023 12:48:39 +0530 Subject: [PATCH 1/4] Tenant onboarding --- .../top-level-operator/addon-package.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/content/en/docs/creating-addons/top-level-operator/addon-package.md b/content/en/docs/creating-addons/top-level-operator/addon-package.md index 638eb06a..850c8e5e 100644 --- a/content/en/docs/creating-addons/top-level-operator/addon-package.md +++ b/content/en/docs/creating-addons/top-level-operator/addon-package.md @@ -44,3 +44,21 @@ respectively. *To have these values inject you must maintain the default naming All the values in `.spec.config.addonsv1` can be injected into the objects contained in your packageImage. See the [package operator documentation](https://package-operator.run/docs/guides/packaging-an-application/#go-templates) to see how to do this. + +## Tenants Onboarding Steps + +Team's can generate the packageImage themselves using the [package operator documentation](https://package-operator.run/docs/guides/packaging-an-application/#build--validate) or Team can use Managed Tenants Bundles (MTB) facilities. + + +For the reference-addon packageImage, we are using MTB. + +In MTB, Teams just have to create a "package" directory: +https://gitlab.cee.redhat.com/service/managed-tenants-bundles/-/tree/main/addons/reference-addon/package and add the manifests there, alongside the manifests.yaml[PackageManifest] . + +MTB CI will create the packageImage (in addition to the OLM Index Image which are also part of the Team's addon folder https://gitlab.cee.redhat.com/service/managed-tenants-bundles/-/tree/main/addons/reference-addon ) . + +Last step for the Team is to raise a MR to managed-tenants repository https://gitlab.cee.redhat.com/service/managed-tenants/-/blob/main/addons/reference-addon/addonimagesets/stage/reference-addon.v0.10.1.yaml#L24 , adding a new AddonIMageSet with those images. + + + + From cc065423b150a0c2bb2ca9526d4e6c7eac1cf57c Mon Sep 17 00:00:00 2001 From: Venkatesh S <122962872+venkateshsredhat@users.noreply.github.com> Date: Mon, 26 Jun 2023 12:53:06 +0530 Subject: [PATCH 2/4] Update addon-package.md --- .../creating-addons/top-level-operator/addon-package.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/content/en/docs/creating-addons/top-level-operator/addon-package.md b/content/en/docs/creating-addons/top-level-operator/addon-package.md index 850c8e5e..4ed13e9a 100644 --- a/content/en/docs/creating-addons/top-level-operator/addon-package.md +++ b/content/en/docs/creating-addons/top-level-operator/addon-package.md @@ -47,12 +47,11 @@ how to do this. ## Tenants Onboarding Steps -Team's can generate the packageImage themselves using the [package operator documentation](https://package-operator.run/docs/guides/packaging-an-application/#build--validate) or Team can use Managed Tenants Bundles (MTB) facilities. +Team's can generate the packageImage themselves using the [package operator documentation](https://package-operator.run/docs/guides/packaging-an-application/#build--validate) or Team's can use Managed Tenants Bundles (MTB) facilities. +Below are the Steps for generating the packageImage using MTB for reference-addon packageImage : -For the reference-addon packageImage, we are using MTB. - -In MTB, Teams just have to create a "package" directory: +In MTB, a Team just have to create a "package" directory: https://gitlab.cee.redhat.com/service/managed-tenants-bundles/-/tree/main/addons/reference-addon/package and add the manifests there, alongside the manifests.yaml[PackageManifest] . MTB CI will create the packageImage (in addition to the OLM Index Image which are also part of the Team's addon folder https://gitlab.cee.redhat.com/service/managed-tenants-bundles/-/tree/main/addons/reference-addon ) . From 1afeb701a5162e8afe365d796df6cce94bc81c9e Mon Sep 17 00:00:00 2001 From: Venkatesh S <122962872+venkateshsredhat@users.noreply.github.com> Date: Mon, 26 Jun 2023 16:41:58 +0530 Subject: [PATCH 3/4] Update addon-package.md Based on review --- .../top-level-operator/addon-package.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/content/en/docs/creating-addons/top-level-operator/addon-package.md b/content/en/docs/creating-addons/top-level-operator/addon-package.md index 4ed13e9a..9f74755d 100644 --- a/content/en/docs/creating-addons/top-level-operator/addon-package.md +++ b/content/en/docs/creating-addons/top-level-operator/addon-package.md @@ -47,17 +47,16 @@ how to do this. ## Tenants Onboarding Steps -Team's can generate the packageImage themselves using the [package operator documentation](https://package-operator.run/docs/guides/packaging-an-application/#build--validate) or Team's can use Managed Tenants Bundles (MTB) facilities. +Teams can generate the packageImage themselves using the [package operator documentation](https://package-operator.run/docs/guides/packaging-an-application/#build--validate) or teams can use Managed Tenants Bundles (MTB) facilities. -Below are the Steps for generating the packageImage using MTB for reference-addon packageImage : +Below are the Steps for generating the packageImage using MTB for reference-addon packageImage: -In MTB, a Team just have to create a "package" directory: +In MTB, a team just has to create a "package" directory: https://gitlab.cee.redhat.com/service/managed-tenants-bundles/-/tree/main/addons/reference-addon/package and add the manifests there, alongside the manifests.yaml[PackageManifest] . -MTB CI will create the packageImage (in addition to the OLM Index Image which are also part of the Team's addon folder https://gitlab.cee.redhat.com/service/managed-tenants-bundles/-/tree/main/addons/reference-addon ) . - -Last step for the Team is to raise a MR to managed-tenants repository https://gitlab.cee.redhat.com/service/managed-tenants/-/blob/main/addons/reference-addon/addonimagesets/stage/reference-addon.v0.10.1.yaml#L24 , adding a new AddonIMageSet with those images. +MTB CI will create the packageImage (in addition to the OLM Index Image which is also part of the Team's addon folder https://gitlab.cee.redhat.com/service/managed-tenants-bundles/-/tree/main/addons/reference-addon) . +The last step for the team is to raise a MR to [managed-tenants repository](https://gitlab.cee.redhat.com/service/managed-tenants/-/blob/main/addons/reference-addon/addonimagesets/stage/reference-addon.v0.10.1.yaml#L24) , adding a new AddonImageSet with those images. From 89c775b32257d46f58190455f14605b6d3ef18f2 Mon Sep 17 00:00:00 2001 From: Venkatesh S Date: Wed, 28 Jun 2023 13:35:40 +0530 Subject: [PATCH 4/4] updated the doc --- .../creating-addons/top-level-operator/addon-package.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/en/docs/creating-addons/top-level-operator/addon-package.md b/content/en/docs/creating-addons/top-level-operator/addon-package.md index 9f74755d..fd97cf56 100644 --- a/content/en/docs/creating-addons/top-level-operator/addon-package.md +++ b/content/en/docs/creating-addons/top-level-operator/addon-package.md @@ -47,16 +47,16 @@ how to do this. ## Tenants Onboarding Steps -Teams can generate the packageImage themselves using the [package operator documentation](https://package-operator.run/docs/guides/packaging-an-application/#build--validate) or teams can use Managed Tenants Bundles (MTB) facilities. +Teams can generate the packageImage themselves using the [package operator documentation](https://package-operator.run/docs/guides/packaging-an-application/#build--validate) although we recommend teams to use Managed Tenants Bundles (MTB) facilities. -Below are the Steps for generating the packageImage using MTB for reference-addon packageImage: +Below are the Steps for generating the packageImage using MTB flow for reference-addon packageImage: In MTB, a team just has to create a "package" directory: https://gitlab.cee.redhat.com/service/managed-tenants-bundles/-/tree/main/addons/reference-addon/package and add the manifests there, alongside the manifests.yaml[PackageManifest] . MTB CI will create the packageImage (in addition to the OLM Index Image which is also part of the Team's addon folder https://gitlab.cee.redhat.com/service/managed-tenants-bundles/-/tree/main/addons/reference-addon) . -The last step for the team is to raise a MR to [managed-tenants repository](https://gitlab.cee.redhat.com/service/managed-tenants/-/blob/main/addons/reference-addon/addonimagesets/stage/reference-addon.v0.10.1.yaml#L24) , adding a new AddonImageSet with those images. +Then MTB CI raises a MR to [managed-tenants repository](https://gitlab.cee.redhat.com/service/managed-tenants/-/blob/main/addons/reference-addon/addonimagesets/stage/reference-addon.v0.10.1.yaml#L24) , adding a new AddonImageSet with those images.