Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
310 changes: 104 additions & 206 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
@@ -1,245 +1,143 @@
# This configuration file dictates the organization of the topic groups and
# topics on the main page of the doc site for this branch. Each record
# consists of the following:
#
# --- <= Record delimiter
# Name: Origin of the Species <= Display name of topic group
# Dir: origin_of_the_species <= Directory name of topic group
# Topics:
# - Name: The Majestic Marmoset <= Topic name
# File: the_majestic_marmoset <= Topic file under group dir +/-
# - Name: The Curious Crocodile <= Topic 2 name
# File: the_curious_crocodile <= Topic 2 file
# - Name: The Numerous Nematodes <= Sub-topic group name
# Dir: the_numerous_nematodes <= Sub-topic group dir
# Topics:
# - Name: The Wily Worm <= Sub-topic name
# File: the_wily_worm <= Sub-topic file under <group dir>/<subtopic dir>
# - Name: The Acrobatic Ascarid <= Sub-topic 2 name
# File: the_acrobatic_ascarid <= Sub-topic 2 file under <group dir>/<subtopic dir>
#
# The ordering of the records in this document determines the ordering of the
# topic groups and topics on the main page.

# This configuration file dictates the hierarchy of topics in OpenShift GitOps.
# Each file defined here is defined as a topic which has a Name and File.
---
Name: Release notes
Dir: release_notes
Name: What's New
Dir: whats_new
Distros: openshift-gitops
Topics:
- Name: Review OpenShift GitOps release notes before you upgrade
File: gitops-release-notes-1-21
- Name: Review OpenShift GitOps release notes before you upgrade
File: gitops-release-notes-1-21
---
Name: Understanding OpenShift GitOps
Dir: understanding_openshift_gitops
Name: Discover
Dir: discover
Distros: openshift-gitops
Topics:
- Name: What is OpenShift GitOps?
File: what-is-gitops
- Name: OpenShift GitOps capabilities and requirements
File: about-redhat-openshift-gitops
- Name: Escalate to Red Hat Support
File: gathering-gitops-diagnostic-information-for-support
- Name: What is OpenShift GitOps?
File: what-is-gitops
- Name: Explore GitOps use cases and scenarios
File: explore-gitops-use-cases-and-scenarios
---
Name: Managing cluster configuration
Dir: declarative_clusterconfig
Name: Plan
Dir: plan
Distros: openshift-gitops
Topics:
- Name: Manage cluster configuration declaratively
File: manage-cluster-configuration-declaratively
- Name: Configure cluster with application deployment
File: configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations
- Name: Customize permissions with user-defined cluster roles
File: customizing-permissions-by-creating-user-defined-cluster-roles-for-cluster-scoped-instances
- Name: Customize permissions with aggregated cluster roles
File: customizing-permissions-by-creating-aggregated-cluster-roles
- Name: Plan a GitOps deployment for your environment
File: plan-a-gitops-deployment
- Name: Choose your GitOps deployment approach
File: choose-your-gitops-deployment-approach
---
Name: Installing GitOps
Dir: installing_gitops
Name: Install
Dir: install
Distros: openshift-gitops
Topics:
- Name: Plan a GitOps deployment for your environment
File: plan-a-gitops-deployment
- Name: Choose your GitOps deployment approach
File: choose-your-gitops-deployment-approach
- Name: Set up GitOps for application deployment
File: set-up-gitops-for-application-deployment
- Name: Install the GitOps Operator
File: installing-openshift-gitops
- Name: Install the GitOps CLI
File: installing-argocd-gitops-cli
- Name: Uninstall GitOps and clean up cluster resources
File: uninstall-gitops-and-clean-up-cluster-resources
- Name: Set up GitOps for application deployment
File: set-up-gitops-for-application-deployment
- Name: Install and configure Argo CD Agent
File: install-and-configure-argo-cd-agent
- Name: Deploy applications with Argo CD Agent
File: deploy-applications-with-argo-cd-agent
- Name: Uninstall GitOps and clean up cluster resources
File: uninstall-gitops-and-clean-up-cluster-resources
---
Name: Argo CD instance
Dir: argocd_instance
Name: Get Started
Dir: get_started
Distros: openshift-gitops
Topics:
- Name: Deploy and scale GitOps infrastructure
File: deploy-and-scale-gitops-infrastructure
- Name: Deploy Argo CD instances
File: setting-up-argocd-instance
- Name: Configure Argo CD custom resource properties
File: argo-cd-cr-component-properties
- Name: Configure webhook secrets for Git providers
File: configure-webhook-secrets-git-providers
- Name: Keep container images up to date automatically
File: using-argo-cd-image-updater
- Name: Deploy your first application with GitOps
File: deploying-a-spring-boot-application-with-argo-cd
---
Name: Access control and user management
Dir: accesscontrol_usermanagement
Name: Configure
Dir: configure
Distros: openshift-gitops
Topics:
- Name: Configure Argo CD permissions
File: configuring-argo-cd-rbac
- Name: Configure SSO by using Dex
File: configuring-sso-on-argo-cd-using-dex
- Name: Configure SSO by using OIDC
File: configuring-sso-for-argo-cd-using-oidc
- Name: Manage local users in Argo CD
File: managing-local-users-in-argo-cd
- Name: Deploy and manage Argo CD instances
File: deploy-and-manage-argo-cd-instances
- Name: Configure Argo CD instance properties
File: configure-argo-cd-instance-properties
- Name: Configure GitOps resources and infrastructure
File: configure-gitops-resources-and-infrastructure
- Name: Scale Argo CD with cluster sharding
File: scale-argo-cd-with-cluster-sharding
- Name: Customize the GitOps console
File: customize-the-gitops-console
- Name: Keep container images up to date automatically
File: keep-container-images-up-to-date-automatically
---
Name: Argo CD applications
Dir: argocd_applications
Name: Deploy
Dir: deploy
Distros: openshift-gitops
Topics:
- Name: Deploy your first application with GitOps
File: deploying-a-spring-boot-application-with-argo-cd
- Name: Deliver and manage applications
File: deliver-and-manage-applications
- Name: Deploy and manage applications
File: creating-an-application-using-gitops-argocd-cli
- Name: Manage apps in non-control plane namespaces
File: managing-apps-in-non-control-plane-namespaces
- Name: Manage application links with managed-by-url
File: managing-application-links-with-managed-by-url-annotation
- Name: GitOps Console plugin
File: working-with-gitops-console-plugin
- Name: Deploy cluster configuration with Argo CD
File: deploy-cluster-configuration-with-argo-cd
- Name: Customize cluster permissions
File: customize-cluster-permissions
- Name: Deploy and sync applications
File: deploy-and-sync-applications
- Name: Manage applications across namespaces
File: manage-applications-across-namespaces
- Name: Manage ApplicationSets
File: manage-applicationsets
---
Name: Argo CD application sets
Dir: argocd_application_sets
Name: Extend
Dir: extend
Distros: openshift-gitops
Topics:
- Name: Manage ApplicationSets
File: managing-app-sets-in-non-control-plane-namespaces
- Name: Use Progressive Sync
File: using-progressive-sync-in-openshift-gitops
- Name: Extend Argo CD with plugins and Progressive Sync
File: extend-argo-cd-with-plugins-and-progressive-sync
- Name: Manage Progressive Sync deletion and troubleshooting
File: manage-progressive-sync-deletion-and-troubleshooting
- Name: Understand and set up Argo Rollouts
File: understand-and-set-up-argo-rollouts
- Name: Manage Argo Rollouts lifecycle and traffic
File: manage-argo-rollouts-lifecycle-and-traffic
- Name: Configure Argo Rollouts scope and plugins
File: configure-argo-rollouts-scope-and-plugins
---
Name: Managing resource use
Dir: managing_resource
Name: Secure
Dir: secure
Distros: openshift-gitops
Topics:
- Name: Configure resource allocation and scaling
File: configuring-resource-quota
- Name: Customize the GitOps console experience
File: configure-resource-requests-and-limits-for-gitops-plugin-components
- Name: Enable secure and self-service GitOps operations
File: enable-secure-and-self-service-gitops-operations
- Name: Configure SSO and external authentication
File: configure-sso-and-external-authentication
- Name: Manage local users and permissions
File: manage-local-users-and-permissions
- Name: Configure secrets management for GitOps
File: configure-secrets-management-for-gitops
- Name: Configure HashiCorp Vault and secure annotations
File: configure-hashicorp-vault-and-secure-annotations
- Name: Secure communication between GitOps components
File: secure-communication-between-gitops-components
---
Name: Multitenancy
Dir: multitenancy
Name: Observe
Dir: observe
Distros: openshift-gitops
Topics:
- Name: Configure multitenancy and namespace management
File: multitenancy-support-in-gitops
- Name: Monitor Argo CD health and performance
File: monitor-argo-cd-health-and-performance
- Name: Monitor application health and configure alerts
File: monitor-application-health-and-configure-alerts
---
Name: Declarative cluster configuration
Dir: declarative_clusterconfig
Name: Troubleshoot
Dir: troubleshoot
Distros: openshift-gitops
Topics:
- Name: Scale Argo CD with cluster sharding
File: sharding-clusters-across-argo-cd-application-controller-replicas
- Name: Diagnose and resolve GitOps issues
File: diagnose-and-resolve-gitops-issues
---
Name: Argo CD Agent architecture
Dir: argo_cd_agent_architecture
Name: Upgrade
Dir: upgrade
Distros: openshift-gitops
Topics:
- Name: Argo CD Agent architecture
File: argocd-agent-architecture-overview
- Name: Maintain GitOps health across upgrades and infrastructure
File: maintain-gitops-health-across-upgrades-and-infrastructure
---
Name: Argo CD Agent installation
Dir: argocd_agent_installation
Name: Reference
Dir: reference
Distros: openshift-gitops
Topics:
- Name: Enable GitOps across multiple clusters
File: enable-gitops-across-multiple-clusters
---
Name: Argo Rollouts
Dir: argo_rollouts
Distros: openshift-gitops
Topics:
- Name: Roll out application updates progressively
File: argo-rollouts-overview
- Name: Use progressive deployment delivery
File: using-argo-rollouts-for-progressive-deployment-delivery
- Name: Argo Rollouts lifecycle operations
File: getting-started-with-argo-rollouts
- Name: Route traffic by using OpenShift Routes
File: routing-traffic-by-using-argo-rollouts
- Name: Route traffic by using OpenShift Service Mesh
File: routing-traffic-by-using-argo-rollouts-for-openshift-service-mesh
- Name: Configure HA for Argo Rollouts
File: enabling-ha-support-for-argo-rollouts
- Name: Namespace-scoped Argo Rollouts
File: enable-support-for-namespace-scoped-argo-rollouts-installation
- Name: Cluster-scoped Argo Rollouts
File: using-cluster-scoped-rollouts-instance-to-manage-rollouts-resources
- Name: Traffic management and metric plugins
File: configuring_traffic_management_and_metric_plugins_in_argo_rollouts
---
Name: Security
Dir: securing_openshift_gitops
Distros: openshift-gitops
Topics:
- Name: Secure communication between components and Redis
File: configuring-secure-communication-with-redis
- Name: Manage secrets securely
File: managing-secrets-securely-using-sscsid-with-gitops
- Name: Mask sensitive annotation values in Argo CD UI
File: masking-sensitive-annotations-in-the-argo-cd-web-ui
---
Name: GitOps CLI (argocd) reference
Dir: gitops_cli_argocd
Distros: openshift-gitops
Topics:
- Name: Default mode
File: logging-in-to-argocd-server-in-default-mode
- Name: GitOps CLI reference
File: argocd-gitops-cli-reference
- Name: Configure shell environment with productivity features
File: configuring-argocd-gitops-cli
---
Name: Observability
Dir: observability
Distros: openshift-gitops
Topics:
- Name: Logging
Dir: logging
Topics:
- Name: View Argo CD logs
File: viewing-argo-cd-logs
- Name: Monitoring
Dir: monitoring
Distros: openshift-gitops
Topics:
- Name: Access monitoring dashboards
File: monitoring-with-gitops-dashboards
- Name: Monitor Argo CD instances
File: monitoring-argo-cd-instances
- Name: Monitor the GitOps Operator performance
File: monitoring-the-gitops-operator-performance
- Name: Monitor health information for application resources
File: health-information-for-resources-deployment
- Name: Monitor Argo CD custom resource workloads
File: monitoring-argo-cd-custom-resource-workloads
---
Name: GitOps workloads on infrastructure nodes
Dir: gitops_workloads_infranodes
Distros: openshift-gitops
Topics:
- Name: Configure infrastructure placement
File: running-gitops-control-plane-workloads-on-infrastructure-nodes
---
Name: Troubleshooting issues
Dir: troubleshooting_gitops_issues
Distros: openshift-gitops
Topics:
- Name: Troubleshoot common GitOps issues
File: auto-reboot-during-argo-cd-sync-with-machine-configurations
- Name: GitOps terminology and CLI reference
File: gitops-terminology-and-cli-reference
- Name: Argo CD custom resource reference
File: argo-cd-custom-resource-reference
6 changes: 3 additions & 3 deletions argocd_agent_installation/argocd-agent-installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,11 @@ include::modules/gitops-troubleshooting-argocd-principal-agent.adoc[leveloffset=
[id="additional-resources_{context}"]
== Additional resources

* xref:../argo_cd_agent_architecture/argocd-agent-architecture-overview.adoc[Argo CD Agent architecture]
* xref:../plan/argocd-agent-architecture-overview.adoc[Argo CD Agent architecture]

* xref:../argocd_applications/managing-apps-in-non-control-plane-namespaces.adoc[Apps in any namespaces]
* xref:../deploy/managing-apps-in-non-control-plane-namespaces.adoc[Apps in any namespaces]

* xref:../declarative_clusterconfig/configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations.adoc#using-argo-cd-instance-to-manage-cluster-scoped-resources_configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations[cluster-scoped Argo CD instance]
* xref:../deploy/configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations.adoc#using-argo-cd-instance-to-manage-cluster-scoped-resources_configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations[cluster-scoped Argo CD instance]

* link:https://developers.redhat.com/content-gateway/rest/browse/pub/cgw/openshift-gitops[argocd-agentctl CLI tool]

Expand Down
1 change: 1 addition & 0 deletions configure/_attributes
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ include::modules/proc_configuring-annotation-based-tracking-in-multiple-argo-cd-
[role="_additional-resources"]
[id="additional-resources_{context}"]
== Additional resources
* xref:../argocd_instance/setting-up-argocd-instance.adoc#gitops-argo-cd-installation_setting-up-argocd-instance[Installing a user-defined Argo CD instance]
* xref:../configure/setting-up-argocd-instance.adoc#gitops-argo-cd-installation_setting-up-argocd-instance[Installing a user-defined Argo CD instance]

* link:https://argo-cd.readthedocs.io/en/stable/operator-manual/config-management-plugins/#config-management-plugins[Config Management Plugins]

Loading