mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-10521: Remove plain bundle docs (TP)
This commit is contained in:
Michael Ryan Peter
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
a49418e8c2
commit
2b16939a03
@@ -1,55 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="olm-managing-po"]
|
||||
= Managing platform Operators (Technology Preview)
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: olm-managing-po
|
||||
|
||||
toc::[]
|
||||
|
||||
A platform Operator is an OLM-based Operator that can be installed during or after an OpenShift Container Platform cluster's Day 0 operations and participates in the cluster's lifecycle. As a cluster administrator, you can manage platform Operators by using the `PlatformOperator` API.
|
||||
|
||||
:FeatureName: The platform Operator type
|
||||
include::snippets/technology-preview.adoc[]
|
||||
|
||||
include::modules/arch-platform-operators.adoc[leveloffset=+1]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../operators/understanding/olm-packaging-format.adoc#olm-rukpak-about_olm-packaging-format[RukPak component and packaging format]
|
||||
* xref:../../installing/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities]
|
||||
|
||||
include::modules/olm-po-techpreview.adoc[leveloffset=+2]
|
||||
|
||||
[id="prerequisites_olm-managing-po"]
|
||||
== Prerequisites
|
||||
|
||||
- Access to an {product-title} cluster using an account with `cluster-admin` permissions.
|
||||
- The `TechPreviewNoUpgrade` feature set enabled on the cluster.
|
||||
+
|
||||
[WARNING]
|
||||
====
|
||||
Enabling the `TechPreviewNoUpgrade` feature set cannot be undone and prevents minor version updates. These feature sets are not recommended on production clusters.
|
||||
====
|
||||
- Only the `redhat-operators` catalog source enabled on the cluster. This is a restriction during the Technology Preview release.
|
||||
- The `oc` command installed on your workstation.
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates]
|
||||
* xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-restricted-networks-operatorhub_olm-managing-custom-catalogs[Disabling the default OperatorHub catalog sources]
|
||||
|
||||
include::modules/olm-installing-po-during.adoc[leveloffset=+1]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../installing/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users]
|
||||
* xref:../../operators/admin/olm-managing-po.adoc#olm-po-techpreview_olm-managing-po[Technology Preview restrictions for platform Operators]
|
||||
|
||||
include::modules/olm-installing-po-after.adoc[leveloffset=+1]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../operators/admin/olm-managing-po.adoc#olm-po-techpreview_olm-managing-po[Technology Preview restrictions for platform Operators]
|
||||
|
||||
include::modules/olm-deleting-po.adoc[leveloffset=+1]
|
||||
@@ -11,10 +11,10 @@ include::snippets/technology-preview.adoc[]
|
||||
|
||||
{olmv1-first} comprises the following component projects:
|
||||
|
||||
Operator Controller:: xref:../../../operators/olm_v1/arch/olmv1-operator-controller.adoc#olmv1-operator-controller[Operator Controller] is the central component of {olmv1} that extends Kubernetes with an API through which users can install and manage the lifecycle of Operators and extensions. It consumes information from each of the following components.
|
||||
Operator Controller:: xref:../../../operators/olm_v1/arch/olmv1-operator-controller.adoc#olmv1-operator-controller[Operator Controller] is the central component of {olmv1} that extends Kubernetes with an API through which users can install and manage the lifecycle of Operators and extensions. It consumes information from catalogd.
|
||||
|
||||
RukPak:: xref:../../../operators/olm_v1/arch/olmv1-rukpak.adoc#olmv1-rukpak[RukPak] is a pluggable solution for packaging and distributing cloud-native content. It supports advanced strategies for installation, updates, and policy.
|
||||
+
|
||||
RukPak provides a content ecosystem for installing a variety of artifacts on a Kubernetes cluster. Artifact examples include Git repositories, Helm charts, and OLM bundles. RukPak can then manage, scale, and upgrade these artifacts in a safe way to enable powerful cluster extensions.
|
||||
|
||||
Catalogd:: xref:../../../operators/olm_v1/arch/olmv1-catalogd.adoc#olmv1-catalogd[Catalogd] is a Kubernetes extension that unpacks file-based catalog (FBC) content packaged and shipped in container images for consumption by on-cluster clients. As a component of the {olmv1} microservices architecture, catalogd hosts metadata for Kubernetes extensions packaged by the authors of the extensions, and as a result helps users discover installable content.
|
||||
Catalogd:: xref:../../../operators/olm_v1/arch/olmv1-catalogd.adoc#olmv1-catalogd[Catalogd] is a Kubernetes extension that unpacks file-based catalog (FBC) content packaged and shipped in container images for consumption by on-cluster clients. As a component of the {olmv1} microservices architecture, catalogd hosts metadata for Kubernetes extensions packaged by the authors of the extensions, and as a result helps users discover installable content.
|
||||
|
||||
@@ -6,9 +6,9 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
{olmv1-first} uses a dependency manager for resolving constraints over catalogs of RukPak bundles.
|
||||
{olmv1-first} uses a dependency manager for resolving constraints over catalogs of bundles.
|
||||
|
||||
:FeatureName: {olmv1}
|
||||
include::snippets/technology-preview.adoc[]
|
||||
|
||||
include::modules/olmv1-dependency-concepts.adoc[leveloffset=+1]
|
||||
include::modules/olmv1-dependency-concepts.adoc[leveloffset=+1]
|
||||
|
||||
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
Operator Controller is the central component of {olmv1-first} and consumes the other {olmv1} components, RukPak and catalogd. It extends Kubernetes with an API through which users can install Operators and extensions.
|
||||
Operator Controller is the central component of {olmv1-first} and consumes the other {olmv1} component, catalogd. It extends Kubernetes with an API through which users can install Operators and extensions.
|
||||
|
||||
:FeatureName: {olmv1}
|
||||
include::snippets/technology-preview.adoc[]
|
||||
@@ -17,4 +17,4 @@ include::modules/olmv1-clusterextension-api.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../../operators/understanding/olm/olm-colocation.adoc#olm-colocation[Operator Lifecycle Manager (OLM) -> Multitenancy and Operator colocation]
|
||||
|
||||
include::modules/olmv1-about-target-versions.adoc[leveloffset=+2]
|
||||
include::modules/olmv1-about-target-versions.adoc[leveloffset=+2]
|
||||
|
||||
@@ -16,8 +16,8 @@ include::modules/olm-rukpak-provisioner.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/olm-rukpak-bundle.adoc[leveloffset=+1]
|
||||
include::modules/olm-rukpak-bundle-immutability.adoc[leveloffset=+2]
|
||||
include::modules/olm-rukpak-plain-bundle.adoc[leveloffset=+2]
|
||||
include::modules/olm-rukpak-registry-bundle.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
|
||||
@@ -39,13 +39,8 @@ Improved control over extension updates::
|
||||
With improved insight into catalog content, administrators can specify target versions for installation and updates. This grants administrators more control over the target version of extension updates. For more information, see xref:../../operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc#olmv1-updating-an-operator_olmv1-installing-operator[Updating an Operator].
|
||||
|
||||
Flexible extension packaging format::
|
||||
Administrators can use file-based catalogs to install and manage the following types of content:
|
||||
Administrators can use file-based catalogs to install and manage extensions, such as {olm}-based Operators, similar to the {olmv0} experience.
|
||||
+
|
||||
--
|
||||
* {olm}-based Operators, similar to the {olmv0} experience
|
||||
* _Plain bundles_, which are static collections of arbitrary Kubernetes manifests
|
||||
--
|
||||
+
|
||||
In addition, bundle size is no longer constrained by the etcd value size limit. For more information, see xref:../../operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc#olmv1-installing-an-operator-from-a-catalog[Installing an Operator from a catalog] and xref:../../operators/olm_v1/olmv1-managing-plain-bundles.adoc#olmv1-managing-plain-bundles[Managing plain bundles].
|
||||
In addition, bundle size is no longer constrained by the etcd value size limit. For more information, see xref:../../operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc#olmv1-installing-an-operator-from-a-catalog[Installing an Operator from a catalog].
|
||||
|
||||
include::modules/olmv1-about-purpose.adoc[leveloffset=+1]
|
||||
include::modules/olmv1-about-purpose.adoc[leveloffset=+1]
|
||||
|
||||
@@ -1,72 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="olmv1-managing-plain-bundles"]
|
||||
= Managing plain bundles in {olmv1} (Technology Preview)
|
||||
|
||||
:context: olmv1-managing-catalogs
|
||||
|
||||
toc::[]
|
||||
|
||||
In {olmv1-first}, a _plain bundle_ is a static collection of arbitrary Kubernetes manifests in YAML format. The experimental `olm.bundle.mediatype` property of the `olm.bundle` schema object differentiates a plain bundle (`plain+v0`) from a regular (`registry+v1`) bundle.
|
||||
|
||||
:FeatureName: {olmv1}
|
||||
include::snippets/technology-preview.adoc[]
|
||||
|
||||
// For more information, see the [Plain Bundle Specification](https://github.com/operator-framework/rukpak/blob/main/docs/bundles/plain.md) in the RukPak repository.
|
||||
|
||||
As a cluster administrator, you can build and publish a file-based catalog that includes a plain bundle image by completing the following procedures:
|
||||
|
||||
. Build a plain bundle image.
|
||||
. Create a file-based catalog.
|
||||
. Add the plain bundle image to your file-based catalog.
|
||||
. Build your catalog as an image.
|
||||
. Publish your catalog image.
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../operators/olm_v1/arch/olmv1-rukpak.adoc#olmv1-rukpak[RukPak component and packaging format]
|
||||
|
||||
[id="prerequisites_olmv1-plain-bundles"]
|
||||
== Prerequisites
|
||||
|
||||
* Access to an {product-title} cluster using an account with `cluster-admin` permissions
|
||||
+
|
||||
--
|
||||
include::snippets/olmv1-cli-only.adoc[]
|
||||
--
|
||||
* The `TechPreviewNoUpgrade` feature set enabled on the cluster
|
||||
+
|
||||
[WARNING]
|
||||
====
|
||||
Enabling the `TechPreviewNoUpgrade` feature set cannot be undone and prevents minor version updates. These feature sets are not recommended on production clusters.
|
||||
====
|
||||
* The OpenShift CLI (`oc`) installed on your workstation
|
||||
* The `opm` CLI installed on your workstation
|
||||
* Docker or Podman installed on your workstation
|
||||
* Push access to a container registry, such as link:https://quay.io[Quay]
|
||||
* Kubernetes manifests for your bundle in a flat directory at the root of your project similar to the following structure:
|
||||
+
|
||||
.Example directory structure
|
||||
[source,terminal]
|
||||
----
|
||||
manifests
|
||||
├── namespace.yaml
|
||||
├── service_account.yaml
|
||||
├── cluster_role.yaml
|
||||
├── cluster_role_binding.yaml
|
||||
└── deployment.yaml
|
||||
----
|
||||
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates]
|
||||
|
||||
// - Only the `redhat-operators` catalog source enabled on the cluster. This is a restriction during the Technology Preview release.
|
||||
|
||||
include::modules/olmv1-building-plain-image.adoc[leveloffset=+1]
|
||||
include::modules/olmv1-creating-fbc.adoc[leveloffset=+1]
|
||||
include::modules/olmv1-adding-plain-to-fbc.adoc[leveloffset=+1]
|
||||
include::modules/olmv1-publishing-fbc.adoc[leveloffset=+1]
|
||||
@@ -83,7 +83,6 @@ include::modules/olm-rukpak-about.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/olm-rukpak-bundle.adoc[leveloffset=+2]
|
||||
include::modules/olm-rukpak-bundle-immutability.adoc[leveloffset=+3]
|
||||
include::modules/olm-rukpak-plain-bundle.adoc[leveloffset=+3]
|
||||
include::modules/olm-rukpak-registry-bundle.adoc[leveloffset=+3]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
Reference in New Issue
Block a user