github.com/argoproj/argo-cd/v3@v3.2.1/docs/user-guide/commands/argocd_admin_repo_generate-spec.md (about)

     1  # `argocd admin repo generate-spec` Command Reference
     2  
     3  ## argocd admin repo generate-spec
     4  
     5  Generate declarative config for a repo
     6  
     7  ```
     8  argocd admin repo generate-spec REPOURL [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    
    15    # Add a Git repository via SSH using a private key for authentication, ignoring the server's host key:
    16    argocd admin repo generate-spec git@git.example.com:repos/repo --insecure-ignore-host-key --ssh-private-key-path ~/id_rsa
    17  
    18    # Add a Git repository via SSH on a non-default port - need to use ssh:// style URLs here
    19    argocd admin repo generate-spec ssh://git@git.example.com:2222/repos/repo --ssh-private-key-path ~/id_rsa
    20  
    21    # Add a private Git repository via HTTPS using username/password and TLS client certificates:
    22    argocd admin repo generate-spec https://git.example.com/repos/repo --username git --password secret --tls-client-cert-path ~/mycert.crt --tls-client-cert-key-path ~/mycert.key
    23  
    24    # Add a private Git BitBucket Data Center repository via HTTPS using bearer token:
    25    argocd admin repo generate-spec https://bitbucket.example.com/scm/proj/repo --bearer-token secret-token
    26  
    27    # Add a private Git repository via HTTPS using username/password without verifying the server's TLS certificate
    28    argocd admin repo generate-spec https://git.example.com/repos/repo --username git --password secret --insecure-skip-server-verification
    29  
    30    # Add a public Helm repository named 'stable' via HTTPS
    31    argocd admin repo generate-spec https://charts.helm.sh/stable --type helm --name stable  
    32  
    33    # Add a private Helm repository named 'stable' via HTTPS
    34    argocd admin repo generate-spec https://charts.helm.sh/stable --type helm --name stable --username test --password test
    35  
    36    # Add a private Helm OCI-based repository named 'stable' via HTTPS
    37    argocd admin repo generate-spec helm-oci-registry.cn-zhangjiakou.cr.aliyuncs.com --type helm --name stable --enable-oci --username test --password test
    38  
    39    # Add a private HTTPS OCI repository named 'stable'
    40    argocd admin repo generate-spec oci://helm-oci-registry.cn-zhangjiakou.cr.aliyuncs.com --type oci --name stable --username test --password test
    41    
    42    # Add a private OCI repository named 'stable' without verifying the server's TLS certificate
    43    argocd admin repo generate-spec oci://helm-oci-registry.cn-zhangjiakou.cr.aliyuncs.com --type oci --name stable --username test --password test --insecure-skip-server-verification
    44    
    45    # Add a private HTTP OCI repository named 'stable'
    46    argocd admin repo generate-spec oci://helm-oci-registry.cn-zhangjiakou.cr.aliyuncs.com --type oci --name stable --username test --password test --insecure-oci-force-http
    47  
    48  ```
    49  
    50  ### Options
    51  
    52  ```
    53        --bearer-token string                     bearer token to the Git BitBucket Data Center repository
    54        --enable-lfs                              enable git-lfs (Large File Support) on this repository
    55        --enable-oci                              enable helm-oci (Helm OCI-Based Repository) (only valid for helm type repositories)
    56        --force-http-basic-auth                   whether to force use of basic auth when connecting repository via HTTP
    57        --gcp-service-account-key-path string     service account key for the Google Cloud Platform
    58        --github-app-enterprise-base-url string   base url to use when using GitHub Enterprise (e.g. https://ghe.example.com/api/v3
    59        --github-app-id int                       id of the GitHub Application
    60        --github-app-installation-id int          installation id of the GitHub Application
    61        --github-app-private-key-path string      private key of the GitHub Application
    62    -h, --help                                    help for generate-spec
    63        --insecure-ignore-host-key                disables SSH strict host key checking (deprecated, use --insecure-skip-server-verification instead)
    64        --insecure-oci-force-http                 Use http when accessing an OCI repository
    65        --insecure-skip-server-verification       disables server certificate and host key checks
    66        --name string                             name of the repository, mandatory for repositories of type helm
    67        --no-proxy string                         don't access these targets via proxy
    68    -o, --output string                           Output format. One of: json|yaml (default "yaml")
    69        --password string                         password to the repository
    70        --project string                          project of the repository
    71        --proxy string                            use proxy to access repository
    72        --ssh-private-key-path string             path to the private ssh key (e.g. ~/.ssh/id_rsa)
    73        --tls-client-cert-key-path string         path to the TLS client cert's key (must be PEM format)
    74        --tls-client-cert-path string             path to the TLS client cert (must be PEM format)
    75        --type string                             type of the repository, "git", "oci" or "helm" (default "git")
    76        --use-azure-workload-identity             whether to use azure workload identity for authentication
    77        --username string                         username to the repository
    78  ```
    79  
    80  ### Options inherited from parent commands
    81  
    82  ```
    83        --argocd-context string           The name of the Argo-CD server context to use
    84        --auth-token string               Authentication token; set this or the ARGOCD_AUTH_TOKEN environment variable
    85        --client-crt string               Client certificate file
    86        --client-crt-key string           Client certificate key file
    87        --config string                   Path to Argo CD config (default "/home/user/.config/argocd/config")
    88        --controller-name string          Name of the Argo CD Application controller; set this or the ARGOCD_APPLICATION_CONTROLLER_NAME environment variable when the controller's name label differs from the default, for example when installing via the Helm chart (default "argocd-application-controller")
    89        --core                            If set to true then CLI talks directly to Kubernetes instead of talking to Argo CD API server
    90        --grpc-web                        Enables gRPC-web protocol. Useful if Argo CD server is behind proxy which does not support HTTP2.
    91        --grpc-web-root-path string       Enables gRPC-web protocol. Useful if Argo CD server is behind proxy which does not support HTTP2. Set web root.
    92    -H, --header strings                  Sets additional header to all requests made by Argo CD CLI. (Can be repeated multiple times to add multiple headers, also supports comma separated headers)
    93        --http-retry-max int              Maximum number of retries to establish http connection to Argo CD server
    94        --insecure                        Skip server certificate and domain verification
    95        --kube-context string             Directs the command to the given kube-context
    96        --logformat string                Set the logging format. One of: json|text (default "json")
    97        --loglevel string                 Set the logging level. One of: debug|info|warn|error (default "info")
    98        --plaintext                       Disable TLS
    99        --port-forward                    Connect to a random argocd-server port using port forwarding
   100        --port-forward-namespace string   Namespace name which should be used for port forwarding
   101        --prompts-enabled                 Force optional interactive prompts to be enabled or disabled, overriding local configuration. If not specified, the local configuration value will be used, which is false by default.
   102        --redis-compress string           Enable this if the application controller is configured with redis compression enabled. (possible values: gzip, none) (default "gzip")
   103        --redis-haproxy-name string       Name of the Redis HA Proxy; set this or the ARGOCD_REDIS_HAPROXY_NAME environment variable when the HA Proxy's name label differs from the default, for example when installing via the Helm chart (default "argocd-redis-ha-haproxy")
   104        --redis-name string               Name of the Redis deployment; set this or the ARGOCD_REDIS_NAME environment variable when the Redis's name label differs from the default, for example when installing via the Helm chart (default "argocd-redis")
   105        --repo-server-name string         Name of the Argo CD Repo server; set this or the ARGOCD_REPO_SERVER_NAME environment variable when the server's name label differs from the default, for example when installing via the Helm chart (default "argocd-repo-server")
   106        --server string                   Argo CD server address
   107        --server-crt string               Server certificate file
   108        --server-name string              Name of the Argo CD API server; set this or the ARGOCD_SERVER_NAME environment variable when the server's name label differs from the default, for example when installing via the Helm chart (default "argocd-server")
   109  ```
   110  
   111  ### SEE ALSO
   112  
   113  * [argocd admin repo](argocd_admin_repo.md)	 - Manage repositories configuration
   114