| Name | pulumi-argocd JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A Pulumi package for creating and managing Argo CD resources. |
| upload_time | 2025-02-13 23:09:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Apache-2.0 |
| keywords |
argocd
category/cloud
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Argo CD Resource Provider
The Argo CD Resource Provider lets you manage [Argo CD](https://argoproj.github.io/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`:
```bash
npm install @three14/pulumi-argocd
```
or `yarn`:
```bash
yarn add @three14/pulumi-argocd
```
### Python
To use from Python, install using `pip`:
```bash
pip install pulumi-argocd
```
### Go
To use from Go, use `go get` to grab the latest version of the library:
```bash
go get github.com/pulumi/pulumi-argocd/sdk/go/...
```
### .NET
To use from .NET, install using `dotnet add package`:
```bash
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](https://www.pulumi.com/registry/packages/argocd/api-docs/).
Raw data
{
"_id": null,
"home_page": null,
"name": "pulumi-argocd",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "argocd, category/cloud",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/fe/5d/073428c7f0c541207e87435a230f022b86e10d635af3fdb6bbe154a6d649/pulumi_argocd-0.1.0.tar.gz",
"platform": null,
"description": "# Argo CD Resource Provider\n\nThe Argo CD Resource Provider lets you manage [Argo CD](https://argoproj.github.io/cd/) resources.\n\n## Installing\n\nThis package is available for several languages/platforms:\n\n### Node.js (JavaScript/TypeScript)\n\nTo use from JavaScript or TypeScript in Node.js, install using either `npm`:\n\n```bash\nnpm install @three14/pulumi-argocd\n```\n\nor `yarn`:\n\n```bash\nyarn add @three14/pulumi-argocd\n```\n\n### Python\n\nTo use from Python, install using `pip`:\n\n```bash\npip install pulumi-argocd\n```\n\n### Go\n\nTo use from Go, use `go get` to grab the latest version of the library:\n\n```bash\ngo get github.com/pulumi/pulumi-argocd/sdk/go/...\n```\n\n### .NET\n\nTo use from .NET, install using `dotnet add package`:\n\n```bash\ndotnet add package Three14.Argocd\n```\n\n## Configuration\n\nThe following configuration points are available for the `argocd` provider:\n\n- `argocd:auth_token` (String, Sensitive) ArgoCD authentication token, takes precedence over `username`/`password`. Can be set through the `ARGOCD_AUTH_TOKEN` environment variable.\n- `argocd:cert_file` (String) Additional root CA certificates file to add to the client TLS connection pool.\n- `argocd:client_cert_file` (String) Client certificate.\n- `argocd:client_cert_key` (String) Client certificate key.\n- `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.\n- `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.\n- `argocd:core` (Boolean) Configure direct access using Kubernetes API server.\n\n **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).\n\n 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\n > `The plugin encountered an error, and failed to respond to the plugin.(*GRPCProvider).ReadResource call. The plugin logs may contain more details.`\n\n 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`.\n- `argocd:grpc_web` (Boolean) Whether to use gRPC web proxy client. Useful if Argo CD server is behind proxy which does not support HTTP2.\n- `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.\n- `argocd:headers` (Set of String) Additional headers to add to each request to the ArgoCD server.\n- `argocd:insecure` (Boolean) Whether to skip TLS server certificate. Can be set through the `ARGOCD_INSECURE` environment variable.\n- `argocd:password` (String, Sensitive) Authentication password. Can be set through the `ARGOCD_AUTH_PASSWORD` environment variable.\n- `argocd:plain_text` (Boolean) Whether to initiate an unencrypted connection to ArgoCD server.\n- `argocd:port_forward` (Boolean) Connect to a random argocd-server port using port forwarding.\n- `argocd:port_forward_with_namespace` (String) Namespace name which should be used for port forwarding.\n- `argocd:server_addr` (String) ArgoCD server address with port. Can be set through the `ARGOCD_SERVER` environment variable.\n- `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`.\n- `argocd:user_agent` (String) User-Agent request header override.\n- `argocd:username` (String) Authentication username. Can be set through the `ARGOCD_AUTH_USERNAME` environment variable.\n\n## Reference\n\nFor detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/argocd/api-docs/).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Pulumi package for creating and managing Argo CD resources.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://argoproj.github.io",
"Repository": "https://github.com/Three141/pulumi-argocd"
},
"split_keywords": [
"argocd",
" category/cloud"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b4758115a0aadba51c83e85dc161dcb106fc2035e57773241739c6eb2cb5bff3",
"md5": "43b27371e8afa949eda38c25aefe6741",
"sha256": "58fa4b229af79e74da4c2aa0b8c70575fec4124d9f2ff381be5e1678435b9616"
},
"downloads": -1,
"filename": "pulumi_argocd-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "43b27371e8afa949eda38c25aefe6741",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 1078510,
"upload_time": "2025-02-13T23:09:44",
"upload_time_iso_8601": "2025-02-13T23:09:44.525077Z",
"url": "https://files.pythonhosted.org/packages/b4/75/8115a0aadba51c83e85dc161dcb106fc2035e57773241739c6eb2cb5bff3/pulumi_argocd-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fe5d073428c7f0c541207e87435a230f022b86e10d635af3fdb6bbe154a6d649",
"md5": "9d871494d88c123ae09ca527214c5139",
"sha256": "850d33a665411ab75d55b9136069ece341e936a6ffb2bee6191f3f02d5211619"
},
"downloads": -1,
"filename": "pulumi_argocd-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "9d871494d88c123ae09ca527214c5139",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1058578,
"upload_time": "2025-02-13T23:09:45",
"upload_time_iso_8601": "2025-02-13T23:09:45.868780Z",
"url": "https://files.pythonhosted.org/packages/fe/5d/073428c7f0c541207e87435a230f022b86e10d635af3fdb6bbe154a6d649/pulumi_argocd-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-13 23:09:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Three141",
"github_project": "pulumi-argocd",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pulumi-argocd"
}
