Skip to main content

A Pulumi package for creating and managing Argo CD resources.

Project description

Argo CD Resource Provider

The Argo CD Resource Provider lets you manage Argo CD resources.

Installing

This package is available for several languages/platforms:

Node.js (JavaScript/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

npm install @three14/pulumi-argocd

or yarn:

yarn add @three14/pulumi-argocd

Python

To use from Python, install using pip:

pip install pulumi-argocd

Go

To use from Go, use go get to grab the latest version of the library:

go get github.com/pulumi/pulumi-argocd/sdk/go/...

.NET

To use from .NET, install using dotnet add package:

dotnet add package Three14.Argocd

Configuration

The following configuration points are available for the argocd provider:

  • argocd:auth_token (String, Sensitive) ArgoCD authentication token, takes precedence over username/password. Can be set through the ARGOCD_AUTH_TOKEN environment variable.

  • argocd:cert_file (String) Additional root CA certificates file to add to the client TLS connection pool.

  • argocd:client_cert_file (String) Client certificate.

  • argocd:client_cert_key (String) Client certificate key.

  • argocd:config_path (String) Override the default config path of $HOME/.config/argocd/config. Only relevant when argocd:use_local_config. Can be set through the ARGOCD_CONFIG_PATH environment variable.

  • argocd:context (String) Context to choose when using a local ArgoCD config file. Only relevant when use_local_config. Can be set through ARGOCD_CONTEXT environment variable.

  • argocd:core (Boolean) Configure direct access using Kubernetes API server.

    Warning: this feature works by starting a local ArgoCD API server that talks directly to the Kubernetes API using the current context in the default kubeconfig (~/.kube/config). This behavior cannot be overridden using either environment variables or the kubernetes block in the provider configuration at present).

    If the server fails to start (e.g. your kubeconfig is misconfigured) then the provider will fail as a result of the argocd module forcing it to exit and no logs will be available to help you debug this. The error message will be similar to

    The plugin encountered an error, and failed to respond to the plugin.(*GRPCProvider).ReadResource call. The plugin logs may contain more details.

    To debug this, you will need to login via the ArgoCD CLI using argocd login --core and then running an operation. E.g. argocd app list.

  • argocd:grpc_web (Boolean) Whether to use gRPC web proxy client. Useful if Argo CD server is behind proxy which does not support HTTP2.

  • argocd:grpc_web_root_path (String) Use the gRPC web proxy client and set the web root, e.g. argo-cd. Useful if the Argo CD server is behind a proxy at a non-root path.

  • argocd:headers (Set of String) Additional headers to add to each request to the ArgoCD server.

  • argocd:insecure (Boolean) Whether to skip TLS server certificate. Can be set through the ARGOCD_INSECURE environment variable.

  • argocd:password (String, Sensitive) Authentication password. Can be set through the ARGOCD_AUTH_PASSWORD environment variable.

  • argocd:plain_text (Boolean) Whether to initiate an unencrypted connection to ArgoCD server.

  • argocd:port_forward (Boolean) Connect to a random argocd-server port using port forwarding.

  • argocd:port_forward_with_namespace (String) Namespace name which should be used for port forwarding.

  • argocd:server_addr (String) ArgoCD server address with port. Can be set through the ARGOCD_SERVER environment variable.

  • argocd:use_local_config (Boolean) Use the authentication settings found in the local config file. Useful when you have previously logged in using SSO. Conflicts with auth_token, username and password.

  • argocd:user_agent (String) User-Agent request header override.

  • argocd:username (String) Authentication username. Can be set through the ARGOCD_AUTH_USERNAME environment variable.

Reference

For detailed reference documentation, please visit the Pulumi registry.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pulumi_argocd-1.0.1.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pulumi_argocd-1.0.1-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file pulumi_argocd-1.0.1.tar.gz.

File metadata

  • Download URL: pulumi_argocd-1.0.1.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for pulumi_argocd-1.0.1.tar.gz
Algorithm Hash digest
SHA256 155cb9f5a8e034beaa88ca699cf514c86abad27acc378e830450b6cae0807910
MD5 4715071e7a959f7e5493a01184e4ff9a
BLAKE2b-256 d04a0bee3a05ba85aa3529b09c83df6fa8460452a81310c14689e71d66fc1e03

See more details on using hashes here.

File details

Details for the file pulumi_argocd-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: pulumi_argocd-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for pulumi_argocd-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7481e4f3b91436501163425d6e425ed8c4de640433dc38e7598e13d494fa22ed
MD5 3ec040673731d0ccfc52c873d232e695
BLAKE2b-256 53cae62b897c92b2759e5652de673af774e3533f69c6b139c9c8feb9c5a53829

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page