github.com/argoproj-labs/argocd-operator@v0.10.0/docs/reference/argocdexport.md (about)

     1  # ArgoCDExport
     2  
     3  The `ArgoCDExport` resource is a Kubernetes Custom Resource (CRD) that describes the desired state for the export of a given 
     4  Argo CD cluster and enables disaster recovery for the components that make up Argo CD.
     5  
     6  When the Argo CD Operator sees a new ArgoCDExport resource, the operator manages the built-in Argo CD export process.
     7  
     8  The ArgoCDExport Custom Resource consists of the following properties.
     9  
    10  Name | Default | Description
    11  --- | --- | ---
    12  [**Argocd**](#argocd) | [Empty] | The name of an ArgoCD instance to export.
    13  [**Image**](#image) | `quay.io/jmckind/argocd-operator-util` | The container image for the export Job.
    14  [**Schedule**](#schedule) | [Empty] | Export schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
    15  [**Storage**](#storage-options) | [Object] | The storage configuration options.
    16  [**Version**](#version) | v0.0.15 (SHA) | The tag to use with the container image for the export Job.
    17  
    18  ## Argocd
    19  
    20  The name of an ArgoCD instance to export.
    21  
    22  ### Argocd Example
    23  
    24  The following example sets the name of an ArgoCD resource to export.
    25  
    26  ``` yaml
    27  apiVersion: argoproj.io/v1alpha1
    28  kind: ArgoCDExport
    29  metadata:
    30    name: example-argocdexport
    31    labels:
    32      example: argocd
    33  spec:
    34    argocd: example-argocd
    35  ```
    36  
    37  ## Image
    38  
    39  The container image for the export Job.
    40  
    41  ### Image Example
    42  
    43  The following example sets the default value using the `Image` property on the `ArgoCDExport` resource.
    44  
    45  ``` yaml
    46  apiVersion: argoproj.io/v1alpha1
    47  kind: ArgoCDExport
    48  metadata:
    49    name: example-argocdexport
    50    labels:
    51      example: image
    52  spec:
    53    image: quay.io/jmckind/argocd-operator-util
    54  ```
    55  
    56  ## Schedule
    57  
    58  The export schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
    59  
    60  ### Schedule Example
    61  
    62  The following example sets a recurring export schedule that runs daily at midnight. 
    63  
    64  ``` yaml
    65  apiVersion: argoproj.io/v1alpha1
    66  kind: ArgoCDExport
    67  metadata:
    68    name: example-argocdexport
    69    labels:
    70      example: schedule
    71  spec:
    72    schedule: "0 0 * * *"
    73  ```
    74  
    75  ## Storage Options
    76  
    77  The following properties are available for configuring the storage for the export data.
    78  
    79  Name | Default | Description
    80  --- | --- | ---
    81  Backend | `local` | The storage backend to use, must be "local", "aws", "azure" or "gcp".
    82  PVC | [Object] | The [PersistentVolumeClaimSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.17/#persistentvolumeclaimspec-v1-core) specifying the desired characteristics for a PersistentVolumeClaim.
    83  SecretName | [Export Name] | The name of a Secret with encryption key, credentials, etc.
    84  
    85  ### Storage Example
    86  
    87  The following example sets the default values using the `Storage` property on the `ArgoCDExport` resource.
    88  
    89  ``` yaml
    90  apiVersion: argoproj.io/v1alpha1
    91  kind: ArgoCDExport
    92  metadata:
    93    name: example-argocdexport
    94    labels:
    95      example: storage
    96  spec:
    97    storage:
    98      backend: local
    99      pvc: {}
   100      secretName: example-argocdexport
   101  ```
   102  
   103  ## Version
   104  
   105  The tag to use with the container image for all Argo CD components.
   106  
   107  ### Version Example
   108  
   109  The following example sets the default value using the `Version` property on the `ArgoCDExport` resource.
   110  
   111  ``` yaml
   112  apiVersion: argoproj.io/v1alpha1
   113  kind: ArgoCDExport
   114  metadata:
   115    name: example-argocdexport
   116    labels:
   117      example: version
   118  spec:
   119    version: v0.0.15
   120  ```