1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

OSDOCS-14603-3: ESO assembly and modules

This commit is contained in:
aravipra
2025-06-13 21:07:27 +05:30
committed by openshift-cherrypick-robot
parent 1436f7a86b
commit 297e5f3a81
20 changed files with 847 additions and 2 deletions

View File

@@ -0,0 +1,30 @@
:_mod-docs-content-type: ASSEMBLY
[id="external-secrets-operator-install"]
= Installing the {external-secrets-operator}
include::_attributes/common-attributes.adoc[]
:context: external-secrets-operator-install
toc::[]
The {external-secrets-operator} is not installed on the {product-title} by default. Install the {external-secrets-operator-short} by using either the web console or the command-line interface (CLI).
:FeatureName: The {external-secrets-operator}
include::snippets/technology-preview.adoc[leveloffset=+1]
//Limitations of application installation and uninstallation
include::modules/external-secrets-operator-limitations.adoc[leveloffset=+1]
//Installing the {external-secrets-operator} using the web console
include::modules/external-secrets-operator-install-console.adoc[leveloffset=+1]
//Installing using CLI
include::modules/external-secrets-operator-install-cli.adoc[leveloffset=+1]
[role="_additional-resources"]
[id="external-secrets-operator-install_additional-resources"]
== Additional resources
* xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster]
//== Installing the external secrets operand using CLI
include::modules/external-secrets-operand-install-cli.adoc[leveloffset=+1]

View File

@@ -0,0 +1,26 @@
:_mod-docs-content-type: ASSEMBLY
[id="external-secrets-operator-monitoring"]
= Monitoring the {external-secrets-operator}
include::_attributes/common-attributes.adoc[]
:context: external-secrets-operator-monitoring
toc::[]
You can expose controller metrics for the {external-secrets-operator} in the format provided by the Prometheus Operator.
:FeatureName: The {external-secrets-operator}
include::snippets/technology-preview.adoc[leveloffset=+1]
// Enabling metrics for the {external-secrets-operator-short}
include::modules/external-secrets-enable-metrics.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* xref:../../observability/monitoring/configuring-user-workload-monitoring/configuring-metrics-uwm.adoc#setting-up-metrics-collection-for-user-defined-projects_configuring-metrics-uwm[Setting up metrics collection for user-defined projects]
// Querying metrics for the {external-secrets-operator-short}
include::modules/external-secrets-query-metrics.adoc[leveloffset=+1]
// Enabling metrics for the external secrets operand
include::modules/external-secrets-enable-metrics-operand.adoc[leveloffset=+1]

View File

@@ -0,0 +1,35 @@
:_mod-docs-content-type: ASSEMBLY
[id="external-secrets-operator-release-notes"]
= {external-secrets-operator} release notes
include::_attributes/common-attributes.adoc[]
:context: external-secrets-operator-release-notes
toc::[]
The {external-secrets-operator} is a cluster-wide service that provides lifecycle management for secrets fetched from external secret management systems.
These release notes track the development of {external-secrets-operator-short}.
:FeatureName: The {external-secrets-operator}
include::snippets/technology-preview.adoc[leveloffset=+1]
For more information, see xref:../../security/external_secrets_operator/index.adoc#external-secrets-operator-about[{external-secrets-operator-short} overview].
[id="external-secrets-operator-release-notes-0-1-0_{context}"]
== Release notes for {external-secrets-operator} 0.1.0 (Technology Preview)
Issued: 2025-06-26
The following advisories are available for the {external-secrets-operator} 0.1.0:
* link:https://access.redhat.com/errata/RHBA-2025:9747[RHBA-2025:9747]
* link:https://access.redhat.com/errata/RHBA-2025:9746[RHBA-2025:9746]
* link:https://access.redhat.com/errata/RHBA-2025:9757[RHBA-2025:9757]
* link:https://access.redhat.com/errata/RHBA-2025:9763[RHBA-2025:9763]
Version `0.1.0` of the {external-secrets-operator} is based on the upstream external-secrets version `0.14.3`. For more information, see the link:https://github.com/external-secrets/external-secrets/releases/tag/v0.14.3[external-secrets project release notes for v0.14.3].
[id="external-secrets-operator-0-1-0-features-enhancements_{context}"]
=== New features and enhancements
* This is the initial, Technology Preview release of the {external-secrets-operator}.

View File

@@ -0,0 +1,21 @@
:_mod-docs-content-type: ASSEMBLY
[id="external-secrets-operator-uninstall"]
= Uninstalling the {external-secrets-operator}
include::_attributes/common-attributes.adoc[]
:context: external-secrets-operator-uninstall
toc::[]
You can remove the {external-secrets-operator} from {product-title} by uninstalling the Operator and removing its related resources.
:FeatureName: The {external-secrets-operator}
include::snippets/technology-preview.adoc[leveloffset=+1]
// Uninstalling the {external-secrets-operator-short}
include::modules/external-secrets-operator-uninstall-console.adoc[leveloffset=+1]
// Removing {external-secrets-operator-short}
include::modules/external-secrets-remove-resources.adoc[leveloffset=+1]
// Removing {external-secrets-operator-short} using CLI
include::modules/external-secrets-remove-resources-cli.adoc[leveloffset=+1]

View File

@@ -6,10 +6,28 @@ include::_attributes/common-attributes.adoc[]
toc::[]
//Details to be added
The {external-secrets-operator} operates as a cluster-wide service to deploy and manage the `external-secrets` application. The `external-secrets` application integrates with external secrets management systems and performs secret fetching, refreshing, and provisioning within the cluster.
:FeatureName: The {external-secrets-operator}
include::snippets/technology-preview.adoc[leveloffset=+1]
//About the {external-secrets-operator}
include::modules/external-secrets-about.adoc[leveloffset=+1]
//About the external secrets provide types
include::modules/external-secrets-provider-types.adoc[leveloffset=+1]
//Test coverage table for tested provider type
include::modules/external-secrets-test-coverage.adoc[leveloffset=+1]
//FIPS compliant support
include::modules/external-secrets-fips-support.adoc[leveloffset=+1]
[role="_additional-resources"]
[id="external-secrets-operator-about_additional-resources"]
== Additional resources
// Details to be added
* link:https://external-secrets.io/latest/[external-secrets application]
* xref:../../security/container_security/security-compliance.adoc#security-compliance[Understanding compliance]
* xref:../../installing/overview/installing-fips.adoc#installing-fips-mode_installing-fips[Installing a cluster in FIPS mode]
* xref:../../installing/overview/installing-preparing.adoc#installing-preparing-security[Do you need extra security for your cluster?]