Skip to content

Commit 4c88abb

Browse files
committed
1 parent 37de879 commit 4c88abb

File tree

147 files changed

+399
-399
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

147 files changed

+399
-399
lines changed

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
If you found a security issue that you want to disclose confidentially, contact Red Hat's Product Security team.
44

5-
For more details, see [Security Contacts and Procedures](https://access.redhat.com/security/team/contact).
5+
For more details, see [Security Contacts and Procedures](https://access.redhat.com/risk_compliance/team/contact).

about/architecture.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The hub cluster aggregates information from multiple clusters by using an asynch
3030

3131
The _managed_ cluster is the term that is used to define additional clusters that are managed by the hub cluster. The connection between the two is completed by using the _Klusterlet_, which is the agent that is installed on the managed cluster. The managed cluster receives and applies requests from the hub cluster and enables it to service cluster lifecycle, application lifecycle, governanace and risk, and observability on the managed cluster.
3232

33-
For example, managed clusters send metrics to the hub cluster if the observability service is enabled. See link:../observing_environments/observe_environments.adoc#observing-environments[Observing environments] to receive metrics and optimize the health of all managed clusters.
33+
For example, managed clusters send metrics to the hub cluster if the observability service is enabled. See link:../observability/observe_environments.adoc#observing-environments[Observing environments] to receive metrics and optimize the health of all managed clusters.
3434

3535
[#cluster-lifecycle]
3636
== Cluster lifecycle
@@ -39,7 +39,7 @@ For example, managed clusters send metrics to the hub cluster if the observabili
3939

4040
From the hub cluster console, you can view an aggregation of all cluster health statuses, or view individual health metrics of many Kubernetes clusters. Additionally, you can upgrade managed {ocp-short} clusters individually or in bulk, as well as destroy any {ocp-short} clusters that you created using your hub cluster.
4141

42-
See link:../manage_cluster/intro.adoc#managing-your-clusters[Managing your clusters] to learn about managing clusters, which is part of _Cluster lifecycle_.
42+
See link:../clusters/intro.adoc#managing-your-clusters[Managing your clusters] to learn about managing clusters, which is part of _Cluster lifecycle_.
4343

4444
[#application-lifecycle]
4545
== Application lifecycle
@@ -48,22 +48,22 @@ See link:../manage_cluster/intro.adoc#managing-your-clusters[Managing your clust
4848

4949
A multicluster application uses the Kubernetes specification, but provides additional automation of the deployment and lifecycle management of resources. As a technology preview function, the integration of Ansible Tower jobs enables scheduling automated tasks.
5050

51-
See link:../manage_applications/app_management_overview.adoc#managing-applications[Managing applications] for more application topics.
51+
See link:../applications/app_management_overview.adoc#managing-applications[Managing applications] for more application topics.
5252

5353
[#governance-and-risk]
5454
== Governance and risk
5555

5656
_Governance and risk_ enables you to define policies that either enforce security compliance, or alert you of changes that violate the configured compliance requirements for your environment. You can manage the policies and compliance requirements across all of your management clusters from a central interface page.
5757
After you configure a {product-title-short} hub cluster and a managed cluster, you can view and create policies with the {product-title-short} policy framework. You can take advantage of the https://github.com/open-cluster-management/policy-collection/tree/master/community[`policy-collection` community] to see what policies community members created and contributed, as well as contribute your own policies for others to use.
5858

59-
For more information about Governance and risk, see the link:../security/security_intro.adoc#security[Security] introduction. Additionally, learn about access requirements from the link:../security/rbac.adoc#role-based-access-control[Role-based access control] documentation.
59+
For more information about Governance and risk, see the link:../risk_compliance/security_intro.adoc#security[Security] introduction. Additionally, learn about access requirements from the link:../risk_compliance/rbac.adoc#role-based-access-control[Role-based access control] documentation.
6060

6161
[#observability-arch]
6262
== Observability
6363

6464
The _Observability_ component collects and reports the status and health of the {ocp-short} version 4.x, or later, managed clusters to the hub cluster. You can create custom alerts to inform you of problems with your fleet of managed clusters. Because it requires configured persistent storage, observability must be enabled after the {product-title-short} installation.
6565

66-
For more information about Observability, see link:../observing_environments/observe_environments_intro.adoc#observing-environments-intro[Observing environments introduction].
66+
For more information about Observability, see link:../observability/observe_environments_intro.adoc#observing-environments-intro[Observing environments introduction].
6767

6868
See the product link:../install/install_overview.adoc#installing[Installing] section to prepare your cluster and get configuration information.
6969

about/quick_start.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
See the product architecture at xref:../about/architecture.adoc#multicluster-architecture[Multicluster architecture].
1515

16-
After you learn about the hub cluster and managed cluster architecture, learn about the link:../manage_cluster/supported_clouds.adoc#supported-clouds[Supported clouds], which lists the cloud provider cluster options.
16+
After you learn about the hub cluster and managed cluster architecture, learn about the link:../clusters/supported_clouds.adoc#supported-clouds[Supported clouds], which lists the cloud provider cluster options.
1717

1818
The hub cluster is a {ocp} cluster version 4.5, 4.6, or 4.7 and can run on any https://docs.openshift.com/container-platform/4.7/architecture/architecture-installation.html[supported {ocp} infrastructure].
1919

@@ -39,9 +39,9 @@ After installation, review the link:../console/console_intro.adoc#web-console[We
3939
You are now ready to create and import clusters.
4040
From your hub cluster, you can create clusters from other Kubernetes services to manage, and you can view cluster information.
4141

42-
. See link:../manage_cluster/create.adoc#creating-a-cluster[Creating a cluster] to learn about the types of managed clusters you can create.
42+
. See link:../clusters/create.adoc#creating-a-cluster[Creating a cluster] to learn about the types of managed clusters you can create.
4343
When you create a managed cluster, the new managed cluster imports automatically.
44-
. If you have a cluster that you want to import manually, you can view link:../manage_cluster/import.adoc#importing-a-target-managed-cluster-to-the-hub-cluster[Importing a target managed cluster to the hub cluster] to learn how to import a managed cluster.
44+
. If you have a cluster that you want to import manually, you can view link:../clusters/import.adoc#importing-a-target-managed-cluster-to-the-hub-cluster[Importing a target managed cluster to the hub cluster] to learn how to import a managed cluster.
4545
. When you no longer need to manage a cluster, you can detach that cluster from the _Cluster page_.
4646

4747
[#manage-applications]
@@ -50,7 +50,7 @@ When you create a managed cluster, the new managed cluster imports automatically
5050
You can start managing applications on any created and imported managed clusters.
5151
The types of resources that you can create are applications, channels, subscriptions, and placement rules.
5252

53-
. Learn more about the resources and how to create and manage them at link:../manage_applications/app_management_overview.adoc#managing-applications[Managing applications].
53+
. Learn more about the resources and how to create and manage them at link:../applications/app_management_overview.adoc#managing-applications[Managing applications].
5454
Add or edit your `.yaml` file to create your resources.
5555
. View and edit your resources from the _Applications Dashboard_.
5656

@@ -60,7 +60,7 @@ Add or edit your `.yaml` file to create your resources.
6060
You can also manage security and compliance across your created and imported managed clusters.
6161

6262
. Create a policy using the _policy_ templates.
63-
See the link:../security/policy_example.adoc#policy-overview[Policy overview] for details about how to create a policy with a `.yaml` file template.
63+
See the link:../risk_compliance/policy_example.adoc#policy-overview[Policy overview] for details about how to create a policy with a `.yaml` file template.
6464
. From the _Policies_ page, you can view a summary of cluster and policy violations.
6565
. View your policies from the _Governance and risk_ page in the console.
6666
You can also view policy details from the cluster _Overview_.
@@ -70,5 +70,5 @@ You can also view policy details from the cluster _Overview_.
7070

7171
You can enable the observability service to gain insight and optimize your managed clusters. Enable the observability service operator (`multicluster-observability-operator`) to monitor the health of your managed clusters.
7272

73-
. Learn more about link:../observing_environments/observe_environments.adoc#observing-environments[Observing environments] and how to link:../observing_environments/observability_enable.adoc#enable-observability[Enable observability service].
74-
. Learn about link:../observing_environments/customize_observability.adoc#customizing-observability[Customizing observability].
73+
. Learn more about link:../observability/observe_environments.adoc#observing-environments[Observing environments] and how to link:../observability/observability_enable.adoc#enable-observability[Enable observability service].
74+
. Learn about link:../observability/customize_observability.adoc#customizing-observability[Customizing observability].

apis/api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
You can access APIs to create and manage application resources, channels, subscriptions, and to query information.
55

6-
*User required access:* You can only perform actions that your role is assigned. Learn about access requirements from the link:../security/rbac.adoc#role-based-access-control[Role-based access control] documentation.
6+
*User required access:* You can only perform actions that your role is assigned. Learn about access requirements from the link:../risk_compliance/rbac.adoc#role-based-access-control[Role-based access control] documentation.
77

88
For more information, review the API documentation for each of the following resources:
99

applications/app_advanced_config.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[#application-advanced-configuration]
2+
= Application advanced configuration
3+
4+
Within {product-title}, applications are composed of multiple application resources. You can use channel, subscription, and placement rule resources to help you deploy, update, and manage your overall applications.
5+
6+
Both single and multicluster applications use the same Kubernetes specifications, but multicluster applications involve more automation of the deployment and application management lifecycle.
7+
8+
All of the application component resources for {product-title} applications are defined in YAML file spec sections.
9+
When you need to create or update an application component resource, you need to create or edit the appropriate spec section to include the labels for defining your resource.
10+
11+
View the following application advanced configuration topics:
12+
13+
14+
* xref:../applications/subscribe_git_resources.adoc#subscribing-git-resources[Subscribing Git resources]
15+
* xref:../applications/configuring_git_channel.adoc#configuring-git-channel[Configuring application channel and subscription for a secure Git connection]
16+
* xref:../applications/ansible_config.adoc#setting-up-ansible[Setting up Ansible Tower tasks]
17+
* xref:../applications/config_argo.adoc#configuring-argo[Configuring managed clusters for Argo CD]
18+
* xref:../applications/package_overrides.adoc#configuring-package-overrides[Configuring package overrides]
19+
* xref:../applications/channel_sample.adoc#channel-samples[Channel samples]
20+
* xref:../applications/subscription_sample.adoc#subscription-samples[Subscription samples]
21+
* xref:../applications/placement_sample.adoc#placement-rule-samples[Placement rule samples]
22+
* xref:../applications/app_sample.adoc#application-samples[Application samples]

manage_applications/app_console.adoc renamed to applications/app_console.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The console includes a dashboard for managing the application lifecycle. You can
55

66
See the following application console capabilities:
77

8-
*Important:* Actions are based on your assigned role. Learn about access requirements from the link:../security/rbac.adoc#role-based-access-control[Role-based access control] documentation.
8+
*Important:* Actions are based on your assigned role. Learn about access requirements from the link:../risk_compliance/rbac.adoc#role-based-access-control[Role-based access control] documentation.
99

1010
* Visualize deployed applications across your clusters, including any associated resource repositories, subscriptions, and placement configurations.
1111
@@ -63,7 +63,7 @@ The topology provides a visual representation of the application that was select
6363
**Notes:** The cluster CPU and memory percentage that is displayed is the percentage that is currently utilized. This value is rounded down, so a very small value might display as `0`.
6464
6565
+
66-
For Helm subscriptions, see link:../manage_applications/package_overrides.adoc#configuring-package-overrides[Configuring package overrides] to define the appropriate `packageName` and the `packageAlias` to get an accurate topology display.
66+
For Helm subscriptions, see link:../applications/package_overrides.adoc#configuring-package-overrides[Configuring package overrides] to define the appropriate `packageName` and the `packageAlias` to get an accurate topology display.
6767
+
6868

6969
* View a successful Ansible Tower deployment if you are using Ansible tasks as prehook or posthook for the deployed application.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
[#managing-applications]
2+
= Managing applications
3+
4+
Review the following topics to learn more about creating, deploying, and managing your applications. This guide assumes familiarity with Kubernetes concepts and terminology.
5+
Key Kubernetes terms and components are not defined. For more information about Kubernetes concepts, see https://kubernetes.io/docs/home/[Kubernetes Documentation].
6+
7+
The application management functions provide you with unified and simplified options for constructing and deploying applications and application updates. With these functions, your developers and DevOps personnel can create and manage applications across environments through channel and subscription-based automation.
8+
9+
See the following topics:
10+
11+
* xref:../applications/app_model.adoc#application-model-and-definitions[Application model and definitions]
12+
* xref:../applications/app_console.adoc#application-console[Application console]
13+
* xref:../applications/app_resources.adoc#managing-application-resources[Managing application resources]
14+
* xref:../applications/manage_apps_git.adoc#managing-apps-with-git-repositories[Managing apps with Git repositories]
15+
* xref:../applications/manage_apps_helm.adoc#managing-apps-with-helm-cluster-repositories[Managing apps with Helm repositories]
16+
* xref:../applications/manage_apps_object.adoc#managing-apps-with-object-storage-repositories[Managing apps with Object storage repositories]
17+
* xref:../applications/app_advanced_config.adoc#application-advanced-configuration[Application advanced configuration]
18+
* xref:../applications/subscribe_git_resources.adoc#subscribing-git-resources[Subscribing Git resources]
19+
* xref:../applications/configuring_git_channel.adoc#configuring-git-channel[Configuring application channel and subscription for a secure Git connection]
20+
* xref:../applications/ansible_config.adoc#setting-up-ansible[Setting up Ansible Tower tasks]
21+
* xref:../applications/config_argo.adoc#configuring-argo[Configuring managed clusters for Argo CD]
22+
* xref:../applications/scheduling_deployment.adoc#scheduling-a-deployment[Scheduling a deployment]
23+
* xref:../applications/package_overrides.adoc#configuring-package-overrides[Configuring package overrides]
24+
* xref:../applications/channel_sample.adoc#channel-samples[Channel samples]
25+
* xref:../applications/subscription_sample.adoc#subscription-samples[Subscription samples]
26+
* xref:../applications/placement_sample.adoc#placement-rule-samples[Placement rule samples]
27+
* xref:../applications/app_sample.adoc#application-samples[Application samples]

manage_applications/app_model.adoc renamed to applications/app_model.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,15 @@ Placement rules (`placementrule.apps.open-cluster-management.io`) define the tar
5454

5555
Learn more from the following documentation:
5656

57-
* xref:../manage_applications/app_console.adoc#application-console[Application console]
58-
* xref:../manage_applications/app_resources.adoc#managing-application-resources[Managing application resources]
59-
* xref:../manage_applications/manage_apps_git.adoc#managing-apps-with-git-repositories[Managing apps with Git repositories]
60-
* xref:../manage_applications/manage_apps_helm.adoc#managing-apps-with-helm-cluster-repositories[Managing apps with Helm repositories]
61-
* xref:../manage_applications/manage_apps_object.adoc#managing-apps-with-object-storage-repositories[Managing apps with Object storage repositories]
62-
* xref:../manage_applications/app_advanced_config.adoc#application-advanced-configuration[Application advanced configuration]
63-
* xref:../manage_applications/subscribe_git_resources.adoc#subscribing-git-resources[Subscribing Git resources]
64-
* xref:../manage_applications/ansible_config.adoc#setting-up-ansible[Setting up Ansible Tower tasks]
65-
* xref:../manage_applications/channel_sample.adoc#channel-samples[Channel samples]
66-
* xref:../manage_applications/subscription_sample.adoc#subscription-samples[Subscription samples]
67-
* xref:../manage_applications/placement_sample.adoc#placement-rule-samples[Placement rule samples]
68-
* xref:../manage_applications/app_sample.adoc#application-samples[Application samples]
57+
* xref:../applications/app_console.adoc#application-console[Application console]
58+
* xref:../applications/app_resources.adoc#managing-application-resources[Managing application resources]
59+
* xref:../applications/manage_apps_git.adoc#managing-apps-with-git-repositories[Managing apps with Git repositories]
60+
* xref:../applications/manage_apps_helm.adoc#managing-apps-with-helm-cluster-repositories[Managing apps with Helm repositories]
61+
* xref:../applications/manage_apps_object.adoc#managing-apps-with-object-storage-repositories[Managing apps with Object storage repositories]
62+
* xref:../applications/app_advanced_config.adoc#application-advanced-configuration[Application advanced configuration]
63+
* xref:../applications/subscribe_git_resources.adoc#subscribing-git-resources[Subscribing Git resources]
64+
* xref:../applications/ansible_config.adoc#setting-up-ansible[Setting up Ansible Tower tasks]
65+
* xref:../applications/channel_sample.adoc#channel-samples[Channel samples]
66+
* xref:../applications/subscription_sample.adoc#subscription-samples[Subscription samples]
67+
* xref:../applications/placement_sample.adoc#placement-rule-samples[Placement rule samples]
68+
* xref:../applications/app_sample.adoc#application-samples[Application samples]

applications/app_resources.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[#managing-application-resources]
2+
= Managing application resources
3+
4+
From the console, you can create applications by using Git repositories, Helm repositories, and Object storage repositories.
5+
6+
**Important:** Git Channels can share a namespace with all other channel types: Helm, Object storage, and other Git namespaces.
7+
8+
See the following topics to start managing apps:
9+
10+
* xref:../applications/manage_apps_git.adoc#managing-apps-with-git-repositories[Managing apps with Git repositories]
11+
* xref:../applications/manage_apps_helm.adoc#managing-apps-with-helm-cluster-repositories[Managing apps with Helm repositories]
12+
* xref:../applications/manage_apps_object.adoc#managing-apps-with-object-storage-repositories[Managing apps with Object storage repositories]
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)