Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. KubernetesAgentWorker
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.KubernetesAgentWorker

Explore with Pulumi AI

octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

This resource manages Kubernetes agent workers in Octopus Deploy.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  minimal:
    type: octopusdeploy:KubernetesAgentWorker
    properties:
      thumbprint: 96203ED84246201C26A2F4360D7CBC36AC1D232D
      uri: poll://kcxzcv2fpsxkn6tk9u6d/
      workerPools:
        - worker-pools-1
  optionals:
    type: octopusdeploy:KubernetesAgentWorker
    properties:
      isDisabled: true
      machinePolicyId: machinepolicies-1
      thumbprint: 96203ED84246201C26A2F4360D7CBC36AC1D232D
      upgradeLocked: true
      uri: poll://kcxzcv2fpsxkn6tk9u6d/
      workerPools:
        - worker-pools-1
        - worker-pools-3
Copy

Create KubernetesAgentWorker Resource

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

Constructor syntax

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

@overload
def KubernetesAgentWorker(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          thumbprint: Optional[str] = None,
                          uri: Optional[str] = None,
                          worker_pool_ids: Optional[Sequence[str]] = None,
                          communication_mode: Optional[str] = None,
                          is_disabled: Optional[bool] = None,
                          kubernetes_agent_worker_id: Optional[str] = None,
                          machine_policy_id: Optional[str] = None,
                          name: Optional[str] = None,
                          space_id: Optional[str] = None,
                          upgrade_locked: Optional[bool] = None)
func NewKubernetesAgentWorker(ctx *Context, name string, args KubernetesAgentWorkerArgs, opts ...ResourceOption) (*KubernetesAgentWorker, error)
public KubernetesAgentWorker(string name, KubernetesAgentWorkerArgs args, CustomResourceOptions? opts = null)
public KubernetesAgentWorker(String name, KubernetesAgentWorkerArgs args)
public KubernetesAgentWorker(String name, KubernetesAgentWorkerArgs args, CustomResourceOptions options)

type: octopusdeploy:KubernetesAgentWorker
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. KubernetesAgentWorkerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. KubernetesAgentWorkerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. KubernetesAgentWorkerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. KubernetesAgentWorkerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. KubernetesAgentWorkerArgs
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 kubernetesAgentWorkerResource = new Octopusdeploy.KubernetesAgentWorker("kubernetesAgentWorkerResource", new()
{
    Thumbprint = "string",
    Uri = "string",
    WorkerPoolIds = new[]
    {
        "string",
    },
    CommunicationMode = "string",
    IsDisabled = false,
    KubernetesAgentWorkerId = "string",
    MachinePolicyId = "string",
    Name = "string",
    SpaceId = "string",
    UpgradeLocked = false,
});
Copy
example, err := octopusdeploy.NewKubernetesAgentWorker(ctx, "kubernetesAgentWorkerResource", &octopusdeploy.KubernetesAgentWorkerArgs{
Thumbprint: pulumi.String("string"),
Uri: pulumi.String("string"),
WorkerPoolIds: pulumi.StringArray{
pulumi.String("string"),
},
CommunicationMode: pulumi.String("string"),
IsDisabled: pulumi.Bool(false),
KubernetesAgentWorkerId: pulumi.String("string"),
MachinePolicyId: pulumi.String("string"),
Name: pulumi.String("string"),
SpaceId: pulumi.String("string"),
UpgradeLocked: pulumi.Bool(false),
})
Copy
var kubernetesAgentWorkerResource = new KubernetesAgentWorker("kubernetesAgentWorkerResource", KubernetesAgentWorkerArgs.builder()
    .thumbprint("string")
    .uri("string")
    .workerPoolIds("string")
    .communicationMode("string")
    .isDisabled(false)
    .kubernetesAgentWorkerId("string")
    .machinePolicyId("string")
    .name("string")
    .spaceId("string")
    .upgradeLocked(false)
    .build());
Copy
kubernetes_agent_worker_resource = octopusdeploy.KubernetesAgentWorker("kubernetesAgentWorkerResource",
    thumbprint="string",
    uri="string",
    worker_pool_ids=["string"],
    communication_mode="string",
    is_disabled=False,
    kubernetes_agent_worker_id="string",
    machine_policy_id="string",
    name="string",
    space_id="string",
    upgrade_locked=False)
Copy
const kubernetesAgentWorkerResource = new octopusdeploy.KubernetesAgentWorker("kubernetesAgentWorkerResource", {
    thumbprint: "string",
    uri: "string",
    workerPoolIds: ["string"],
    communicationMode: "string",
    isDisabled: false,
    kubernetesAgentWorkerId: "string",
    machinePolicyId: "string",
    name: "string",
    spaceId: "string",
    upgradeLocked: false,
});
Copy
type: octopusdeploy:KubernetesAgentWorker
properties:
    communicationMode: string
    isDisabled: false
    kubernetesAgentWorkerId: string
    machinePolicyId: string
    name: string
    spaceId: string
    thumbprint: string
    upgradeLocked: false
    uri: string
    workerPoolIds:
        - string
Copy

KubernetesAgentWorker 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 KubernetesAgentWorker resource accepts the following input properties:

Thumbprint This property is required. string
The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
Uri This property is required. string
The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
WorkerPoolIds This property is required. List<string>
A list of worker pool Ids specifying the pools in which this worker belongs
CommunicationMode string
The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
IsDisabled bool
Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
KubernetesAgentWorkerId string
The unique ID for this resource.
MachinePolicyId string
Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
Name string
The name of this resource.
SpaceId string
The space ID associated with this resource.
UpgradeLocked bool
If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
Thumbprint This property is required. string
The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
Uri This property is required. string
The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
WorkerPoolIds This property is required. []string
A list of worker pool Ids specifying the pools in which this worker belongs
CommunicationMode string
The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
IsDisabled bool
Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
KubernetesAgentWorkerId string
The unique ID for this resource.
MachinePolicyId string
Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
Name string
The name of this resource.
SpaceId string
The space ID associated with this resource.
UpgradeLocked bool
If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
thumbprint This property is required. String
The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
uri This property is required. String
The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
workerPoolIds This property is required. List<String>
A list of worker pool Ids specifying the pools in which this worker belongs
communicationMode String
The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
isDisabled Boolean
Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
kubernetesAgentWorkerId String
The unique ID for this resource.
machinePolicyId String
Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
name String
The name of this resource.
spaceId String
The space ID associated with this resource.
upgradeLocked Boolean
If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
thumbprint This property is required. string
The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
uri This property is required. string
The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
workerPoolIds This property is required. string[]
A list of worker pool Ids specifying the pools in which this worker belongs
communicationMode string
The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
isDisabled boolean
Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
kubernetesAgentWorkerId string
The unique ID for this resource.
machinePolicyId string
Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
name string
The name of this resource.
spaceId string
The space ID associated with this resource.
upgradeLocked boolean
If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
thumbprint This property is required. str
The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
uri This property is required. str
The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
worker_pool_ids This property is required. Sequence[str]
A list of worker pool Ids specifying the pools in which this worker belongs
communication_mode str
The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
is_disabled bool
Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
kubernetes_agent_worker_id str
The unique ID for this resource.
machine_policy_id str
Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
name str
The name of this resource.
space_id str
The space ID associated with this resource.
upgrade_locked bool
If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
thumbprint This property is required. String
The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
uri This property is required. String
The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
workerPoolIds This property is required. List<String>
A list of worker pool Ids specifying the pools in which this worker belongs
communicationMode String
The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
isDisabled Boolean
Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
kubernetesAgentWorkerId String
The unique ID for this resource.
machinePolicyId String
Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
name String
The name of this resource.
spaceId String
The space ID associated with this resource.
upgradeLocked Boolean
If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.

Outputs

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

AgentHelmReleaseName string
Name of the Helm release that the agent belongs to.
AgentKubernetesNamespace string
Name of the Kubernetes namespace where the agent is installed.
AgentTentacleVersion string
Current Tentacle version of the agent
AgentUpgradeStatus string
Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
AgentVersion string
Current Helm chart version of the agent.
Id string
The provider-assigned unique ID for this managed resource.
AgentHelmReleaseName string
Name of the Helm release that the agent belongs to.
AgentKubernetesNamespace string
Name of the Kubernetes namespace where the agent is installed.
AgentTentacleVersion string
Current Tentacle version of the agent
AgentUpgradeStatus string
Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
AgentVersion string
Current Helm chart version of the agent.
Id string
The provider-assigned unique ID for this managed resource.
agentHelmReleaseName String
Name of the Helm release that the agent belongs to.
agentKubernetesNamespace String
Name of the Kubernetes namespace where the agent is installed.
agentTentacleVersion String
Current Tentacle version of the agent
agentUpgradeStatus String
Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
agentVersion String
Current Helm chart version of the agent.
id String
The provider-assigned unique ID for this managed resource.
agentHelmReleaseName string
Name of the Helm release that the agent belongs to.
agentKubernetesNamespace string
Name of the Kubernetes namespace where the agent is installed.
agentTentacleVersion string
Current Tentacle version of the agent
agentUpgradeStatus string
Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
agentVersion string
Current Helm chart version of the agent.
id string
The provider-assigned unique ID for this managed resource.
agent_helm_release_name str
Name of the Helm release that the agent belongs to.
agent_kubernetes_namespace str
Name of the Kubernetes namespace where the agent is installed.
agent_tentacle_version str
Current Tentacle version of the agent
agent_upgrade_status str
Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
agent_version str
Current Helm chart version of the agent.
id str
The provider-assigned unique ID for this managed resource.
agentHelmReleaseName String
Name of the Helm release that the agent belongs to.
agentKubernetesNamespace String
Name of the Kubernetes namespace where the agent is installed.
agentTentacleVersion String
Current Tentacle version of the agent
agentUpgradeStatus String
Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
agentVersion String
Current Helm chart version of the agent.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing KubernetesAgentWorker Resource

Get an existing KubernetesAgentWorker 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?: KubernetesAgentWorkerState, opts?: CustomResourceOptions): KubernetesAgentWorker
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_helm_release_name: Optional[str] = None,
        agent_kubernetes_namespace: Optional[str] = None,
        agent_tentacle_version: Optional[str] = None,
        agent_upgrade_status: Optional[str] = None,
        agent_version: Optional[str] = None,
        communication_mode: Optional[str] = None,
        is_disabled: Optional[bool] = None,
        kubernetes_agent_worker_id: Optional[str] = None,
        machine_policy_id: Optional[str] = None,
        name: Optional[str] = None,
        space_id: Optional[str] = None,
        thumbprint: Optional[str] = None,
        upgrade_locked: Optional[bool] = None,
        uri: Optional[str] = None,
        worker_pool_ids: Optional[Sequence[str]] = None) -> KubernetesAgentWorker
func GetKubernetesAgentWorker(ctx *Context, name string, id IDInput, state *KubernetesAgentWorkerState, opts ...ResourceOption) (*KubernetesAgentWorker, error)
public static KubernetesAgentWorker Get(string name, Input<string> id, KubernetesAgentWorkerState? state, CustomResourceOptions? opts = null)
public static KubernetesAgentWorker get(String name, Output<String> id, KubernetesAgentWorkerState state, CustomResourceOptions options)
resources:  _:    type: octopusdeploy:KubernetesAgentWorker    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AgentHelmReleaseName string
Name of the Helm release that the agent belongs to.
AgentKubernetesNamespace string
Name of the Kubernetes namespace where the agent is installed.
AgentTentacleVersion string
Current Tentacle version of the agent
AgentUpgradeStatus string
Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
AgentVersion string
Current Helm chart version of the agent.
CommunicationMode string
The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
IsDisabled bool
Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
KubernetesAgentWorkerId string
The unique ID for this resource.
MachinePolicyId string
Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
Name string
The name of this resource.
SpaceId string
The space ID associated with this resource.
Thumbprint string
The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
UpgradeLocked bool
If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
Uri string
The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
WorkerPoolIds List<string>
A list of worker pool Ids specifying the pools in which this worker belongs
AgentHelmReleaseName string
Name of the Helm release that the agent belongs to.
AgentKubernetesNamespace string
Name of the Kubernetes namespace where the agent is installed.
AgentTentacleVersion string
Current Tentacle version of the agent
AgentUpgradeStatus string
Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
AgentVersion string
Current Helm chart version of the agent.
CommunicationMode string
The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
IsDisabled bool
Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
KubernetesAgentWorkerId string
The unique ID for this resource.
MachinePolicyId string
Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
Name string
The name of this resource.
SpaceId string
The space ID associated with this resource.
Thumbprint string
The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
UpgradeLocked bool
If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
Uri string
The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
WorkerPoolIds []string
A list of worker pool Ids specifying the pools in which this worker belongs
agentHelmReleaseName String
Name of the Helm release that the agent belongs to.
agentKubernetesNamespace String
Name of the Kubernetes namespace where the agent is installed.
agentTentacleVersion String
Current Tentacle version of the agent
agentUpgradeStatus String
Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
agentVersion String
Current Helm chart version of the agent.
communicationMode String
The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
isDisabled Boolean
Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
kubernetesAgentWorkerId String
The unique ID for this resource.
machinePolicyId String
Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
name String
The name of this resource.
spaceId String
The space ID associated with this resource.
thumbprint String
The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
upgradeLocked Boolean
If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
uri String
The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
workerPoolIds List<String>
A list of worker pool Ids specifying the pools in which this worker belongs
agentHelmReleaseName string
Name of the Helm release that the agent belongs to.
agentKubernetesNamespace string
Name of the Kubernetes namespace where the agent is installed.
agentTentacleVersion string
Current Tentacle version of the agent
agentUpgradeStatus string
Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
agentVersion string
Current Helm chart version of the agent.
communicationMode string
The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
isDisabled boolean
Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
kubernetesAgentWorkerId string
The unique ID for this resource.
machinePolicyId string
Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
name string
The name of this resource.
spaceId string
The space ID associated with this resource.
thumbprint string
The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
upgradeLocked boolean
If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
uri string
The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
workerPoolIds string[]
A list of worker pool Ids specifying the pools in which this worker belongs
agent_helm_release_name str
Name of the Helm release that the agent belongs to.
agent_kubernetes_namespace str
Name of the Kubernetes namespace where the agent is installed.
agent_tentacle_version str
Current Tentacle version of the agent
agent_upgrade_status str
Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
agent_version str
Current Helm chart version of the agent.
communication_mode str
The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
is_disabled bool
Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
kubernetes_agent_worker_id str
The unique ID for this resource.
machine_policy_id str
Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
name str
The name of this resource.
space_id str
The space ID associated with this resource.
thumbprint str
The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
upgrade_locked bool
If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
uri str
The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
worker_pool_ids Sequence[str]
A list of worker pool Ids specifying the pools in which this worker belongs
agentHelmReleaseName String
Name of the Helm release that the agent belongs to.
agentKubernetesNamespace String
Name of the Kubernetes namespace where the agent is installed.
agentTentacleVersion String
Current Tentacle version of the agent
agentUpgradeStatus String
Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
agentVersion String
Current Helm chart version of the agent.
communicationMode String
The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
isDisabled Boolean
Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
kubernetesAgentWorkerId String
The unique ID for this resource.
machinePolicyId String
Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
name String
The name of this resource.
spaceId String
The space ID associated with this resource.
thumbprint String
The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
upgradeLocked Boolean
If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
uri String
The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
workerPoolIds List<String>
A list of worker pool Ids specifying the pools in which this worker belongs

Import

$ pulumi import octopusdeploy:index/kubernetesAgentWorker:KubernetesAgentWorker [options] octopusdeploy_kubernetes_agent_worker.<name> <machine-id>
Copy

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

Package Details

Repository
octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
License
Notes
This Pulumi package is based on the octopusdeploy Terraform Provider.
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy