Este conteúdo não está disponível no idioma selecionado.

Chapter 5. GitOps Console plugin setup and configuration


The GitOps Console plugin extends the OpenShift Container Platform web console with GitOps resource management capabilities. You can enable the plugin through the web console or CLI to view and manage Argo CD Applications, ApplicationSets, AppProjects, ImageUpdaters, and Argo Rollouts.

5.1. Prerequisites

  • You have access to an OpenShift Container Platform cluster running version 4.19 or later.

5.2. Overview of the GitOps Console plugin

The GitOps Console plugin extends the OpenShift Container Platform web console by adding GitOps resources. The plugin is available as part of the Red Hat OpenShift GitOps Operator and provides a console UI for managing Argo CD and Argo Rollouts custom resources.

After you install the Red Hat OpenShift GitOps Operator and enable the GitOps Console plugin, the OpenShift Container Platform web console displays a GitOps navigation tab in the Administrator or Core platform perspective. The GitOps navigation tab replaces the previous Environments tab and related pages in the Developer perspective.

The GitOps navigation tab provides access to the following Argo CD and Argo Rollouts resources:

  • Applications: Argo CD Applications for managing application deployments
  • ApplicationSets: Argo CD ApplicationSets for managing multiple Applications
  • AppProjects: Argo CD AppProjects for controlling application access and permissions
  • ImageUpdaters: Argo CD Image Updater resources for automated image updates (requires ImageUpdater CRD)
  • Rollouts: Argo Rollouts resources for progressive deployment strategies (requires Rollout CRD)

Each of the above resources provide list and details pages that follow the standard OpenShift Container Platform web console experience. You can use these pages to:

  • View GitOps resources in a selected namespace
  • Create resources by using YAML templates
  • Edit labels and annotations
  • Filter resources by status
  • Access related resources and events

The GitOps Console plugin integrates with the console navigation, allowing you to navigate between related resources and access contextual actions for each resource type.

5.3. About the GitOps Console plugin

The GitOps Console plugin extends the OpenShift Container Platform web console with GitOps resource management capabilities. The plugin provides dedicated pages for viewing and managing Argo CD Applications, ApplicationSets, AppProjects, ImageUpdaters, and Argo Rollouts. The plugin is not intended to replace the Argo CD UI or Argo Rollouts UI. Use the Argo CD UI and Argo Rollouts UI for functionality that is not provided by the plugin.

The plugin is cluster-scoped. A single plugin deployment serves all Argo CD instances on the cluster. You do not install a separate plugin for each Argo CD instance.

When multiple Argo CD instances exist in different namespaces, their resources appear together in the GitOps pages. Use the namespace selector to limit the view to one namespace or to browse across namespaces.

The View in Argo CD action opens the selected application in the Argo CD user interface. This action requires a Route to the Argo CD server.

The Red Hat OpenShift GitOps Operator enables the plugin automatically during installation. If you disable the plugin, you can re-enable it manually through the web console or the CLI.

5.4. Enable the GitOps Console plugin using the web console

The GitOps Console plugin is enabled by default after you install the Red Hat OpenShift GitOps Operator. If you disable the plugin, you can enable it manually through the OpenShift Container Platform web console.

Prerequisites

  • You have installed the Red Hat OpenShift GitOps Operator.
  • You have access to the OpenShift Container Platform web console with cluster administrator permissions.

Procedure

  1. In the OpenShift Container Platform web console, navigate to Home Overview.
  2. In the Status panel, click Dynamic Plugins.

    A popup appears with a link to view all dynamic plugins.

  3. Click View all.
  4. Under the Console plugins tab, find gitops-plugin.
  5. If the plugin is disabled, click Enable.

    The browser might require a refresh. After refreshing, the page indicates that the plugin is Enabled.

Verification

  • Navigate to GitOps in the navigation menu and verify that you can access Applications, ApplicationSets, and AppProjects.
  • If the ImageUpdater and Rollout CRDs are installed on the cluster, also verify that you can access ImageUpdaters and Rollouts.

5.5. Enable the GitOps Console plugin using the CLI

If you disable the GitOps Console plugin after installing the Red Hat OpenShift GitOps Operator, you can enable it manually using the OpenShift CLI.

Prerequisites

  • You have installed the Red Hat OpenShift GitOps Operator.
  • You have access to the cluster with cluster-admin permissions.
  • You have installed the OpenShift CLI (oc).

The console loads plugins listed in spec.plugins on console.operator.openshift.io/cluster.

Procedure

  1. Check which plugins are enabled:

    $ oc get console.operator.openshift.io cluster -o jsonpath='{.spec.plugins}{"\n"}'
  2. To enable gitops-plugin:

    • If step 1 printed a JSON array, for example ["monitoring-plugin"], append gitops-plugin:

      $ PLUGIN_PATCH='[{"op":"add","path":"/spec/plugins/-","value":"gitops-plugin"}]'
      $ oc patch console.operator.openshift.io cluster --type=json -p "${PLUGIN_PATCH}"
    • If step 1 printed nothing or only null, spec.plugins is missing. Create the list:

      $ PLUGIN_PATCH='[{"op":"add","path":"/spec/plugins","value":["gitops-plugin"]}]'
      $ oc patch console.operator.openshift.io cluster --type=json -p "${PLUGIN_PATCH}"

      Skip this step if gitops-plugin is already in the list from the previous command.

  3. Refresh the browser after the change. The GitOps entry appears in the navigation menu when the plugin is enabled.

Verification

  • Navigate to GitOps in the navigation menu and verify that you can access Applications, ApplicationSets, AppProjects, ImageUpdaters, and Rollouts pages.

5.6. Disable the GitOps Console plugin using the CLI

You can disable the GitOps Console plugin using the OpenShift CLI.

Prerequisites

  • You have access to the cluster with cluster-admin permissions.
  • You have installed the OpenShift CLI (oc).

Procedure

  1. Edit the Console operator and remove gitops-plugin from spec.plugins:

    $ oc edit console.operator.openshift.io cluster

    Example

    spec:
      plugins:
        - monitoring-plugin
        # remove: - gitops-plugin

  2. After saving the change, refresh the browser.

Verification

  • The GitOps entry disappears from the navigation menu when the plugin is disabled.
Red Hat logoGithubRedditYoutubeTwitter

Aprender

Experimente, compre e venda

Comunidades

Sobre a Red Hat

Fornecemos soluções robustas que facilitam o trabalho das empresas em plataformas e ambientes, desde o data center principal até a borda da rede.

Tornando o open source mais inclusivo

A Red Hat está comprometida em substituir a linguagem problemática em nosso código, documentação e propriedades da web. Para mais detalhes veja o Blog da Red Hat.

Sobre a documentação da Red Hat

Legal Notice

Theme

© 2026 Red Hat
Voltar ao topo