Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. GitOpsAgent
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-harness

harness.platform.GitOpsAgent

Explore with Pulumi AI

harness logo
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-harness

    Resource for managing a Harness GitOps Agent.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as harness from "@pulumi/harness";

const example = new harness.platform.GitOpsAgent("example", {
    identifier: "identifier",
    accountId: "account_id",
    projectId: "project_id",
    orgId: "org_id",
    name: "name",
    type: "MANAGED_ARGO_PROVIDER",
    metadatas: [{
        namespace: "namespace",
        highAvailability: true,
    }],
});

    import pulumi
import pulumi_harness as harness

example = harness.platform.GitOpsAgent("example",
    identifier="identifier",
    account_id="account_id",
    project_id="project_id",
    org_id="org_id",
    name="name",
    type="MANAGED_ARGO_PROVIDER",
    metadatas=[{
        "namespace": "namespace",
        "high_availability": True,
    }])

    package main

import (
	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := platform.NewGitOpsAgent(ctx, "example", &platform.GitOpsAgentArgs{
			Identifier: pulumi.String("identifier"),
			AccountId:  pulumi.String("account_id"),
			ProjectId:  pulumi.String("project_id"),
			OrgId:      pulumi.String("org_id"),
			Name:       pulumi.String("name"),
			Type:       pulumi.String("MANAGED_ARGO_PROVIDER"),
			Metadatas: platform.GitOpsAgentMetadataArray{
				&platform.GitOpsAgentMetadataArgs{
					Namespace:        pulumi.String("namespace"),
					HighAvailability: pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Pulumi.Harness;

return await Deployment.RunAsync(() => 
{
    var example = new Harness.Platform.GitOpsAgent("example", new()
    {
        Identifier = "identifier",
        AccountId = "account_id",
        ProjectId = "project_id",
        OrgId = "org_id",
        Name = "name",
        Type = "MANAGED_ARGO_PROVIDER",
        Metadatas = new[]
        {
            new Harness.Platform.Inputs.GitOpsAgentMetadataArgs
            {
                Namespace = "namespace",
                HighAvailability = true,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.GitOpsAgent;
import com.pulumi.harness.platform.GitOpsAgentArgs;
import com.pulumi.harness.platform.inputs.GitOpsAgentMetadataArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new GitOpsAgent("example", GitOpsAgentArgs.builder()
            .identifier("identifier")
            .accountId("account_id")
            .projectId("project_id")
            .orgId("org_id")
            .name("name")
            .type("MANAGED_ARGO_PROVIDER")
            .metadatas(GitOpsAgentMetadataArgs.builder()
                .namespace("namespace")
                .highAvailability(true)
                .build())
            .build());

    }
}

    resources:
  example:
    type: harness:platform:GitOpsAgent
    properties:
      identifier: identifier
      accountId: account_id
      projectId: project_id
      orgId: org_id
      name: name
      type: MANAGED_ARGO_PROVIDER
      metadatas:
        - namespace: namespace
          highAvailability: true

    Create GitOpsAgent Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GitOpsAgent(name: string, args: GitOpsAgentArgs, opts?: CustomResourceOptions);
    @overload
def GitOpsAgent(resource_name: str,
                args: GitOpsAgentArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def GitOpsAgent(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                account_id: Optional[str] = None,
                identifier: Optional[str] = None,
                type: Optional[str] = None,
                description: Optional[str] = None,
                metadatas: Optional[Sequence[GitOpsAgentMetadataArgs]] = None,
                name: Optional[str] = None,
                operator: Optional[str] = None,
                org_id: Optional[str] = None,
                project_id: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
    func NewGitOpsAgent(ctx *Context, name string, args GitOpsAgentArgs, opts ...ResourceOption) (*GitOpsAgent, error)
    public GitOpsAgent(string name, GitOpsAgentArgs args, CustomResourceOptions? opts = null)
    public GitOpsAgent(String name, GitOpsAgentArgs args)
public GitOpsAgent(String name, GitOpsAgentArgs args, CustomResourceOptions options)

    type: harness:platform:GitOpsAgent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GitOpsAgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GitOpsAgentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GitOpsAgentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GitOpsAgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GitOpsAgentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var gitOpsAgentResource = new Harness.Platform.GitOpsAgent("gitOpsAgentResource", new()
{
    AccountId = "string",
    Identifier = "string",
    Type = "string",
    Description = "string",
    Metadatas = new[]
    {
        new Harness.Platform.Inputs.GitOpsAgentMetadataArgs
        {
            HighAvailability = false,
            IsNamespaced = false,
            Namespace = "string",
        },
    },
    Name = "string",
    Operator = "string",
    OrgId = "string",
    ProjectId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := platform.NewGitOpsAgent(ctx, "gitOpsAgentResource", &platform.GitOpsAgentArgs{
	AccountId:   pulumi.String("string"),
	Identifier:  pulumi.String("string"),
	Type:        pulumi.String("string"),
	Description: pulumi.String("string"),
	Metadatas: platform.GitOpsAgentMetadataArray{
		&platform.GitOpsAgentMetadataArgs{
			HighAvailability: pulumi.Bool(false),
			IsNamespaced:     pulumi.Bool(false),
			Namespace:        pulumi.String("string"),
		},
	},
	Name:      pulumi.String("string"),
	Operator:  pulumi.String("string"),
	OrgId:     pulumi.String("string"),
	ProjectId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var gitOpsAgentResource = new GitOpsAgent("gitOpsAgentResource", GitOpsAgentArgs.builder()
    .accountId("string")
    .identifier("string")
    .type("string")
    .description("string")
    .metadatas(GitOpsAgentMetadataArgs.builder()
        .highAvailability(false)
        .isNamespaced(false)
        .namespace("string")
        .build())
    .name("string")
    .operator("string")
    .orgId("string")
    .projectId("string")
    .tags(Map.of("string", "string"))
    .build());

    git_ops_agent_resource = harness.platform.GitOpsAgent("gitOpsAgentResource",
    account_id="string",
    identifier="string",
    type="string",
    description="string",
    metadatas=[{
        "high_availability": False,
        "is_namespaced": False,
        "namespace": "string",
    }],
    name="string",
    operator="string",
    org_id="string",
    project_id="string",
    tags={
        "string": "string",
    })

    const gitOpsAgentResource = new harness.platform.GitOpsAgent("gitOpsAgentResource", {
    accountId: "string",
    identifier: "string",
    type: "string",
    description: "string",
    metadatas: [{
        highAvailability: false,
        isNamespaced: false,
        namespace: "string",
    }],
    name: "string",
    operator: "string",
    orgId: "string",
    projectId: "string",
    tags: {
        string: "string",
    },
});

    type: harness:platform:GitOpsAgent
properties:
    accountId: string
    description: string
    identifier: string
    metadatas:
        - highAvailability: false
          isNamespaced: false
          namespace: string
    name: string
    operator: string
    orgId: string
    projectId: string
    tags:
        string: string
    type: string

    GitOpsAgent Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GitOpsAgent resource accepts the following input properties:

    AccountId string
    Account identifier of the GitOps agent.
    Identifier string
    Identifier of the GitOps agent.
    Type string
    Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
    Description string
    Description of the GitOps agent.
    Metadatas List<GitOpsAgentMetadata>
    Metadata of the agent.
    Name string
    Name of the GitOps agent.
    Operator string
    The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
    OrgId string
    Organization identifier of the GitOps agent.
    ProjectId string
    Project identifier of the GitOps agent.
    Tags Dictionary<string, string>
    Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
    AccountId string
    Account identifier of the GitOps agent.
    Identifier string
    Identifier of the GitOps agent.
    Type string
    Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
    Description string
    Description of the GitOps agent.
    Metadatas []GitOpsAgentMetadataArgs
    Metadata of the agent.
    Name string
    Name of the GitOps agent.
    Operator string
    The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
    OrgId string
    Organization identifier of the GitOps agent.
    ProjectId string
    Project identifier of the GitOps agent.
    Tags map[string]string
    Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
    accountId String
    Account identifier of the GitOps agent.
    identifier String
    Identifier of the GitOps agent.
    type String
    Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
    description String
    Description of the GitOps agent.
    metadatas List<GitOpsAgentMetadata>
    Metadata of the agent.
    name String
    Name of the GitOps agent.
    operator String
    The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
    orgId String
    Organization identifier of the GitOps agent.
    projectId String
    Project identifier of the GitOps agent.
    tags Map<String,String>
    Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
    accountId string
    Account identifier of the GitOps agent.
    identifier string
    Identifier of the GitOps agent.
    type string
    Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
    description string
    Description of the GitOps agent.
    metadatas GitOpsAgentMetadata[]
    Metadata of the agent.
    name string
    Name of the GitOps agent.
    operator string
    The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
    orgId string
    Organization identifier of the GitOps agent.
    projectId string
    Project identifier of the GitOps agent.
    tags {[key: string]: string}
    Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
    account_id str
    Account identifier of the GitOps agent.
    identifier str
    Identifier of the GitOps agent.
    type str
    Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
    description str
    Description of the GitOps agent.
    metadatas Sequence[GitOpsAgentMetadataArgs]
    Metadata of the agent.
    name str
    Name of the GitOps agent.
    operator str
    The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
    org_id str
    Organization identifier of the GitOps agent.
    project_id str
    Project identifier of the GitOps agent.
    tags Mapping[str, str]
    Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
    accountId String
    Account identifier of the GitOps agent.
    identifier String
    Identifier of the GitOps agent.
    type String
    Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
    description String
    Description of the GitOps agent.
    metadatas List<Property Map>
    Metadata of the agent.
    name String
    Name of the GitOps agent.
    operator String
    The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
    orgId String
    Organization identifier of the GitOps agent.
    projectId String
    Project identifier of the GitOps agent.
    tags Map<String>
    Tags for the GitOps agents. These can be used to search or filter the GitOps agents.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GitOpsAgent resource produces the following output properties:

    AgentToken string
    Agent token to be used for authentication of the agent with Harness.
    Id string
    The provider-assigned unique ID for this managed resource.
    AgentToken string
    Agent token to be used for authentication of the agent with Harness.
    Id string
    The provider-assigned unique ID for this managed resource.
    agentToken String
    Agent token to be used for authentication of the agent with Harness.
    id String
    The provider-assigned unique ID for this managed resource.
    agentToken string
    Agent token to be used for authentication of the agent with Harness.
    id string
    The provider-assigned unique ID for this managed resource.
    agent_token str
    Agent token to be used for authentication of the agent with Harness.
    id str
    The provider-assigned unique ID for this managed resource.
    agentToken String
    Agent token to be used for authentication of the agent with Harness.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GitOpsAgent Resource

    Get an existing GitOpsAgent resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GitOpsAgentState, opts?: CustomResourceOptions): GitOpsAgent
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        agent_token: Optional[str] = None,
        description: Optional[str] = None,
        identifier: Optional[str] = None,
        metadatas: Optional[Sequence[GitOpsAgentMetadataArgs]] = None,
        name: Optional[str] = None,
        operator: Optional[str] = None,
        org_id: Optional[str] = None,
        project_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None) -> GitOpsAgent
    func GetGitOpsAgent(ctx *Context, name string, id IDInput, state *GitOpsAgentState, opts ...ResourceOption) (*GitOpsAgent, error)
    public static GitOpsAgent Get(string name, Input<string> id, GitOpsAgentState? state, CustomResourceOptions? opts = null)
    public static GitOpsAgent get(String name, Output<String> id, GitOpsAgentState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    Account identifier of the GitOps agent.
    AgentToken string
    Agent token to be used for authentication of the agent with Harness.
    Description string
    Description of the GitOps agent.
    Identifier string
    Identifier of the GitOps agent.
    Metadatas List<GitOpsAgentMetadata>
    Metadata of the agent.
    Name string
    Name of the GitOps agent.
    Operator string
    The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
    OrgId string
    Organization identifier of the GitOps agent.
    ProjectId string
    Project identifier of the GitOps agent.
    Tags Dictionary<string, string>
    Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
    Type string
    Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
    AccountId string
    Account identifier of the GitOps agent.
    AgentToken string
    Agent token to be used for authentication of the agent with Harness.
    Description string
    Description of the GitOps agent.
    Identifier string
    Identifier of the GitOps agent.
    Metadatas []GitOpsAgentMetadataArgs
    Metadata of the agent.
    Name string
    Name of the GitOps agent.
    Operator string
    The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
    OrgId string
    Organization identifier of the GitOps agent.
    ProjectId string
    Project identifier of the GitOps agent.
    Tags map[string]string
    Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
    Type string
    Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
    accountId String
    Account identifier of the GitOps agent.
    agentToken String
    Agent token to be used for authentication of the agent with Harness.
    description String
    Description of the GitOps agent.
    identifier String
    Identifier of the GitOps agent.
    metadatas List<GitOpsAgentMetadata>
    Metadata of the agent.
    name String
    Name of the GitOps agent.
    operator String
    The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
    orgId String
    Organization identifier of the GitOps agent.
    projectId String
    Project identifier of the GitOps agent.
    tags Map<String,String>
    Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
    type String
    Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
    accountId string
    Account identifier of the GitOps agent.
    agentToken string
    Agent token to be used for authentication of the agent with Harness.
    description string
    Description of the GitOps agent.
    identifier string
    Identifier of the GitOps agent.
    metadatas GitOpsAgentMetadata[]
    Metadata of the agent.
    name string
    Name of the GitOps agent.
    operator string
    The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
    orgId string
    Organization identifier of the GitOps agent.
    projectId string
    Project identifier of the GitOps agent.
    tags {[key: string]: string}
    Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
    type string
    Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
    account_id str
    Account identifier of the GitOps agent.
    agent_token str
    Agent token to be used for authentication of the agent with Harness.
    description str
    Description of the GitOps agent.
    identifier str
    Identifier of the GitOps agent.
    metadatas Sequence[GitOpsAgentMetadataArgs]
    Metadata of the agent.
    name str
    Name of the GitOps agent.
    operator str
    The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
    org_id str
    Organization identifier of the GitOps agent.
    project_id str
    Project identifier of the GitOps agent.
    tags Mapping[str, str]
    Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
    type str
    Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"
    accountId String
    Account identifier of the GitOps agent.
    agentToken String
    Agent token to be used for authentication of the agent with Harness.
    description String
    Description of the GitOps agent.
    identifier String
    Identifier of the GitOps agent.
    metadatas List<Property Map>
    Metadata of the agent.
    name String
    Name of the GitOps agent.
    operator String
    The Operator to use for the Harness GitOps agent. Enum: "ARGO" "FLAMINGO"
    orgId String
    Organization identifier of the GitOps agent.
    projectId String
    Project identifier of the GitOps agent.
    tags Map<String>
    Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
    type String
    Default: "AGENTTYPEUNSET" Enum: "AGENTTYPEUNSET" "CONNECTEDARGOPROVIDER" "MANAGEDARGOPROVIDER"

    Supporting Types

    GitOpsAgentMetadata, GitOpsAgentMetadataArgs

    HighAvailability bool
    Indicates if the agent is deployed in HA mode.
    IsNamespaced bool
    Indicates if the agent is namespaced.
    Namespace string
    The kubernetes namespace where the agent should be installed.
    HighAvailability bool
    Indicates if the agent is deployed in HA mode.
    IsNamespaced bool
    Indicates if the agent is namespaced.
    Namespace string
    The kubernetes namespace where the agent should be installed.
    highAvailability Boolean
    Indicates if the agent is deployed in HA mode.
    isNamespaced Boolean
    Indicates if the agent is namespaced.
    namespace String
    The kubernetes namespace where the agent should be installed.
    highAvailability boolean
    Indicates if the agent is deployed in HA mode.
    isNamespaced boolean
    Indicates if the agent is namespaced.
    namespace string
    The kubernetes namespace where the agent should be installed.
    high_availability bool
    Indicates if the agent is deployed in HA mode.
    is_namespaced bool
    Indicates if the agent is namespaced.
    namespace str
    The kubernetes namespace where the agent should be installed.
    highAvailability Boolean
    Indicates if the agent is deployed in HA mode.
    isNamespaced Boolean
    Indicates if the agent is namespaced.
    namespace String
    The kubernetes namespace where the agent should be installed.

    Import

    Import an Account level Gitops Agent

    $ pulumi import harness:platform/gitOpsAgent:GitOpsAgent example <agent_id>

    Import an Org level Gitops Agent

    $ pulumi import harness:platform/gitOpsAgent:GitOpsAgent example <organization_id>/<agent_id>

    Import a Project level Gitops Agent

    $ pulumi import harness:platform/gitOpsAgent:GitOpsAgent example <organization_id>/<project_id>/<agent_id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
    pulumi/pulumi-harness