github.com/argoproj-labs/argocd-operator@v0.10.0/config/manifests/patches/description.yaml (about)

     1  - op: add
     2    path: "/spec/description"
     3    value: |
     4      ## Overview
     5  
     6      The Argo CD Operator manages the full lifecycle for [Argo CD](https://argoproj.github.io/argo-cd/) and it's
     7      components. The operator's goal is to automate the tasks required when operating an Argo CD cluster.
     8  
     9      Beyond installation, the operator helps to automate the process of upgrading, backing up and restoring as needed and
    10      remove the human as much as possible. In addition, the operator aims to provide deep insights into the Argo CD
    11      environment by configuring Prometheus and Grafana to aggregate, visualize and expose the metrics already exported by
    12      Argo CD.
    13  
    14      The operator aims to provide the following, and is a work in progress.
    15  
    16      * Easy configuration and installation of the Argo CD components with sane defaults to get up and running quickly.
    17      * Provide seamless upgrades to the Argo CD components.
    18      * Ability to back up and restore an Argo CD cluster from a point in time or on a recurring schedule.
    19      * Aggregate and expose the metrics for Argo CD and the operator itself using Prometheus and Grafana.
    20      * Autoscale the Argo CD components as necessary to handle variability in demand.
    21  
    22      ## Usage
    23  
    24      Deploy a basic Argo CD cluster by creating a new ArgoCD resource in the namespace where the operator is installed.
    25  
    26      ```
    27      apiVersion: argoproj.io/v1alpha1
    28      kind: ArgoCD
    29      metadata:
    30        name: example-argocd
    31      spec: {}
    32      ```
    33  
    34      ## Backup
    35  
    36      Backup the cluster above by creating a new ArgoCDExport resource in the namespace where the operator is installed.
    37  
    38      ```
    39      apiVersion: argoproj.io/v1alpha1
    40      kind: ArgoCDExport
    41      metadata:
    42        name: example-argocdexport
    43      spec:
    44        argocd: example-argocd
    45      ```
    46  
    47      See the [documentation](https://argocd-operator.readthedocs.io) and examples on
    48      [github](https://github.com/argoproj-labs/argocd-operator) for more information.