gitlab.ClusterAgentToken
Explore with Pulumi AI
The gitlab.ClusterAgentToken
resource allows to manage the lifecycle of a token for a GitLab Agent for Kubernetes.
Requires at least maintainer permissions on the project.
Requires at least GitLab 15.0
Upstream API: GitLab REST API docs
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
using Helm = Pulumi.Helm;
return await Deployment.RunAsync(() =>
{
// Create token for an agent
var example = new GitLab.ClusterAgentToken("example", new()
{
Project = "12345",
AgentId = 42,
Description = "some token",
});
var thisProject = GitLab.GetProject.Invoke(new()
{
PathWithNamespace = "my-org/example",
});
var thisClusterAgent = new GitLab.ClusterAgent("thisClusterAgent", new()
{
Project = thisProject.Apply(getProjectResult => getProjectResult.Id),
});
var thisClusterAgentToken = new GitLab.ClusterAgentToken("thisClusterAgentToken", new()
{
Project = thisProject.Apply(getProjectResult => getProjectResult.Id),
AgentId = thisClusterAgent.AgentId,
Description = "Token for the my-agent used with `gitlab-agent` Helm Chart",
});
var gitlabAgent = new Helm.Index.Helm_release("gitlabAgent", new()
{
Name = "gitlab-agent",
Namespace = "gitlab-agent",
CreateNamespace = true,
Repository = "https://charts.gitlab.io",
Chart = "gitlab-agent",
Version = "1.2.0",
Set = new[]
{
{
{ "name", "config.token" },
{ "value", thisClusterAgentToken.Token },
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-gitlab/sdk/v6/go/gitlab"
"github.com/pulumi/pulumi-helm/sdk/v1/go/helm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := gitlab.NewClusterAgentToken(ctx, "example", &gitlab.ClusterAgentTokenArgs{
Project: pulumi.String("12345"),
AgentId: pulumi.Int(42),
Description: pulumi.String("some token"),
})
if err != nil {
return err
}
thisProject, err := gitlab.LookupProject(ctx, &gitlab.LookupProjectArgs{
PathWithNamespace: pulumi.StringRef("my-org/example"),
}, nil)
if err != nil {
return err
}
thisClusterAgent, err := gitlab.NewClusterAgent(ctx, "thisClusterAgent", &gitlab.ClusterAgentArgs{
Project: *pulumi.String(thisProject.Id),
})
if err != nil {
return err
}
thisClusterAgentToken, err := gitlab.NewClusterAgentToken(ctx, "thisClusterAgentToken", &gitlab.ClusterAgentTokenArgs{
Project: *pulumi.String(thisProject.Id),
AgentId: thisClusterAgent.AgentId,
Description: pulumi.String("Token for the my-agent used with `gitlab-agent` Helm Chart"),
})
if err != nil {
return err
}
_, err = index.NewHelm_release(ctx, "gitlabAgent", &index.Helm_releaseArgs{
Name: "gitlab-agent",
Namespace: "gitlab-agent",
CreateNamespace: true,
Repository: "https://charts.gitlab.io",
Chart: "gitlab-agent",
Version: "1.2.0",
Set: []map[string]interface{}{
map[string]interface{}{
"name": "config.token",
"value": thisClusterAgentToken.Token,
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.ClusterAgentToken;
import com.pulumi.gitlab.ClusterAgentTokenArgs;
import com.pulumi.gitlab.GitlabFunctions;
import com.pulumi.gitlab.inputs.GetProjectArgs;
import com.pulumi.gitlab.ClusterAgent;
import com.pulumi.gitlab.ClusterAgentArgs;
import com.pulumi.helm.helm_release;
import com.pulumi.helm.Helm_releaseArgs;
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 ClusterAgentToken("example", ClusterAgentTokenArgs.builder()
.project("12345")
.agentId(42)
.description("some token")
.build());
final var thisProject = GitlabFunctions.getProject(GetProjectArgs.builder()
.pathWithNamespace("my-org/example")
.build());
var thisClusterAgent = new ClusterAgent("thisClusterAgent", ClusterAgentArgs.builder()
.project(thisProject.applyValue(getProjectResult -> getProjectResult.id()))
.build());
var thisClusterAgentToken = new ClusterAgentToken("thisClusterAgentToken", ClusterAgentTokenArgs.builder()
.project(thisProject.applyValue(getProjectResult -> getProjectResult.id()))
.agentId(thisClusterAgent.agentId())
.description("Token for the my-agent used with `gitlab-agent` Helm Chart")
.build());
var gitlabAgent = new Helm_release("gitlabAgent", Helm_releaseArgs.builder()
.name("gitlab-agent")
.namespace("gitlab-agent")
.createNamespace(true)
.repository("https://charts.gitlab.io")
.chart("gitlab-agent")
.version("1.2.0")
.set(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
}
}
import pulumi
import pulumi_gitlab as gitlab
import pulumi_helm as helm
# Create token for an agent
example = gitlab.ClusterAgentToken("example",
project="12345",
agent_id=42,
description="some token")
this_project = gitlab.get_project(path_with_namespace="my-org/example")
this_cluster_agent = gitlab.ClusterAgent("thisClusterAgent", project=this_project.id)
this_cluster_agent_token = gitlab.ClusterAgentToken("thisClusterAgentToken",
project=this_project.id,
agent_id=this_cluster_agent.agent_id,
description="Token for the my-agent used with `gitlab-agent` Helm Chart")
gitlab_agent = helm.index.Helm_release("gitlabAgent",
name=gitlab-agent,
namespace=gitlab-agent,
create_namespace=True,
repository=https://charts.gitlab.io,
chart=gitlab-agent,
version=1.2.0,
set=[{
name: config.token,
value: this_cluster_agent_token.token,
}])
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
import * as helm from "@pulumi/helm";
// Create token for an agent
const example = new gitlab.ClusterAgentToken("example", {
project: "12345",
agentId: 42,
description: "some token",
});
const thisProject = gitlab.getProject({
pathWithNamespace: "my-org/example",
});
const thisClusterAgent = new gitlab.ClusterAgent("thisClusterAgent", {project: thisProject.then(thisProject => thisProject.id)});
const thisClusterAgentToken = new gitlab.ClusterAgentToken("thisClusterAgentToken", {
project: thisProject.then(thisProject => thisProject.id),
agentId: thisClusterAgent.agentId,
description: "Token for the my-agent used with `gitlab-agent` Helm Chart",
});
const gitlabAgent = new helm.index.Helm_release("gitlabAgent", {
name: "gitlab-agent",
namespace: "gitlab-agent",
createNamespace: true,
repository: "https://charts.gitlab.io",
chart: "gitlab-agent",
version: "1.2.0",
set: [{
name: "config.token",
value: thisClusterAgentToken.token,
}],
});
resources:
# Create token for an agent
example:
type: gitlab:ClusterAgentToken
properties:
project: '12345'
agentId: 42
description: some token
thisClusterAgent:
type: gitlab:ClusterAgent
properties:
project: ${thisProject.id}
thisClusterAgentToken:
type: gitlab:ClusterAgentToken
properties:
project: ${thisProject.id}
agentId: ${thisClusterAgent.agentId}
description: Token for the my-agent used with `gitlab-agent` Helm Chart
gitlabAgent:
type: helm:helm_release
properties:
name: gitlab-agent
namespace: gitlab-agent
createNamespace: true
repository: https://charts.gitlab.io
chart: gitlab-agent
version: 1.2.0
set:
- name: config.token
value: ${thisClusterAgentToken.token}
variables:
thisProject:
fn::invoke:
Function: gitlab:getProject
Arguments:
pathWithNamespace: my-org/example
Create ClusterAgentToken Resource
new ClusterAgentToken(name: string, args: ClusterAgentTokenArgs, opts?: CustomResourceOptions);
@overload
def ClusterAgentToken(resource_name: str,
opts: Optional[ResourceOptions] = None,
agent_id: Optional[int] = None,
description: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None)
@overload
def ClusterAgentToken(resource_name: str,
args: ClusterAgentTokenArgs,
opts: Optional[ResourceOptions] = None)
func NewClusterAgentToken(ctx *Context, name string, args ClusterAgentTokenArgs, opts ...ResourceOption) (*ClusterAgentToken, error)
public ClusterAgentToken(string name, ClusterAgentTokenArgs args, CustomResourceOptions? opts = null)
public ClusterAgentToken(String name, ClusterAgentTokenArgs args)
public ClusterAgentToken(String name, ClusterAgentTokenArgs args, CustomResourceOptions options)
type: gitlab:ClusterAgentToken
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterAgentTokenArgs
- 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 ClusterAgentTokenArgs
- 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 ClusterAgentTokenArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterAgentTokenArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterAgentTokenArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ClusterAgentToken Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ClusterAgentToken resource accepts the following input properties:
- Agent
Id int The ID of the agent.
- Project string
ID or full path of the project maintained by the authenticated user.
- Description string
The Description for the agent.
- Name string
The Name of the agent.
- Agent
Id int The ID of the agent.
- Project string
ID or full path of the project maintained by the authenticated user.
- Description string
The Description for the agent.
- Name string
The Name of the agent.
- agent
Id Integer The ID of the agent.
- project String
ID or full path of the project maintained by the authenticated user.
- description String
The Description for the agent.
- name String
The Name of the agent.
- agent
Id number The ID of the agent.
- project string
ID or full path of the project maintained by the authenticated user.
- description string
The Description for the agent.
- name string
The Name of the agent.
- agent_
id int The ID of the agent.
- project str
ID or full path of the project maintained by the authenticated user.
- description str
The Description for the agent.
- name str
The Name of the agent.
- agent
Id Number The ID of the agent.
- project String
ID or full path of the project maintained by the authenticated user.
- description String
The Description for the agent.
- name String
The Name of the agent.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClusterAgentToken resource produces the following output properties:
- Created
At string The ISO8601 datetime when the agent was created.
- Created
By intUser Id The ID of the user who created the agent.
- Id string
The provider-assigned unique ID for this managed resource.
- Last
Used stringAt The ISO8601 datetime when the token was last used.
- Status string
The status of the token. Valid values are
active
,revoked
.- Token string
The secret token for the agent. The
token
is not available in imported resources.- Token
Id int The ID of the token.
- Created
At string The ISO8601 datetime when the agent was created.
- Created
By intUser Id The ID of the user who created the agent.
- Id string
The provider-assigned unique ID for this managed resource.
- Last
Used stringAt The ISO8601 datetime when the token was last used.
- Status string
The status of the token. Valid values are
active
,revoked
.- Token string
The secret token for the agent. The
token
is not available in imported resources.- Token
Id int The ID of the token.
- created
At String The ISO8601 datetime when the agent was created.
- created
By IntegerUser Id The ID of the user who created the agent.
- id String
The provider-assigned unique ID for this managed resource.
- last
Used StringAt The ISO8601 datetime when the token was last used.
- status String
The status of the token. Valid values are
active
,revoked
.- token String
The secret token for the agent. The
token
is not available in imported resources.- token
Id Integer The ID of the token.
- created
At string The ISO8601 datetime when the agent was created.
- created
By numberUser Id The ID of the user who created the agent.
- id string
The provider-assigned unique ID for this managed resource.
- last
Used stringAt The ISO8601 datetime when the token was last used.
- status string
The status of the token. Valid values are
active
,revoked
.- token string
The secret token for the agent. The
token
is not available in imported resources.- token
Id number The ID of the token.
- created_
at str The ISO8601 datetime when the agent was created.
- created_
by_ intuser_ id The ID of the user who created the agent.
- id str
The provider-assigned unique ID for this managed resource.
- last_
used_ strat The ISO8601 datetime when the token was last used.
- status str
The status of the token. Valid values are
active
,revoked
.- token str
The secret token for the agent. The
token
is not available in imported resources.- token_
id int The ID of the token.
- created
At String The ISO8601 datetime when the agent was created.
- created
By NumberUser Id The ID of the user who created the agent.
- id String
The provider-assigned unique ID for this managed resource.
- last
Used StringAt The ISO8601 datetime when the token was last used.
- status String
The status of the token. Valid values are
active
,revoked
.- token String
The secret token for the agent. The
token
is not available in imported resources.- token
Id Number The ID of the token.
Look up Existing ClusterAgentToken Resource
Get an existing ClusterAgentToken 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?: ClusterAgentTokenState, opts?: CustomResourceOptions): ClusterAgentToken
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
agent_id: Optional[int] = None,
created_at: Optional[str] = None,
created_by_user_id: Optional[int] = None,
description: Optional[str] = None,
last_used_at: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None,
status: Optional[str] = None,
token: Optional[str] = None,
token_id: Optional[int] = None) -> ClusterAgentToken
func GetClusterAgentToken(ctx *Context, name string, id IDInput, state *ClusterAgentTokenState, opts ...ResourceOption) (*ClusterAgentToken, error)
public static ClusterAgentToken Get(string name, Input<string> id, ClusterAgentTokenState? state, CustomResourceOptions? opts = null)
public static ClusterAgentToken get(String name, Output<String> id, ClusterAgentTokenState 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.
- Agent
Id int The ID of the agent.
- Created
At string The ISO8601 datetime when the agent was created.
- Created
By intUser Id The ID of the user who created the agent.
- Description string
The Description for the agent.
- Last
Used stringAt The ISO8601 datetime when the token was last used.
- Name string
The Name of the agent.
- Project string
ID or full path of the project maintained by the authenticated user.
- Status string
The status of the token. Valid values are
active
,revoked
.- Token string
The secret token for the agent. The
token
is not available in imported resources.- Token
Id int The ID of the token.
- Agent
Id int The ID of the agent.
- Created
At string The ISO8601 datetime when the agent was created.
- Created
By intUser Id The ID of the user who created the agent.
- Description string
The Description for the agent.
- Last
Used stringAt The ISO8601 datetime when the token was last used.
- Name string
The Name of the agent.
- Project string
ID or full path of the project maintained by the authenticated user.
- Status string
The status of the token. Valid values are
active
,revoked
.- Token string
The secret token for the agent. The
token
is not available in imported resources.- Token
Id int The ID of the token.
- agent
Id Integer The ID of the agent.
- created
At String The ISO8601 datetime when the agent was created.
- created
By IntegerUser Id The ID of the user who created the agent.
- description String
The Description for the agent.
- last
Used StringAt The ISO8601 datetime when the token was last used.
- name String
The Name of the agent.
- project String
ID or full path of the project maintained by the authenticated user.
- status String
The status of the token. Valid values are
active
,revoked
.- token String
The secret token for the agent. The
token
is not available in imported resources.- token
Id Integer The ID of the token.
- agent
Id number The ID of the agent.
- created
At string The ISO8601 datetime when the agent was created.
- created
By numberUser Id The ID of the user who created the agent.
- description string
The Description for the agent.
- last
Used stringAt The ISO8601 datetime when the token was last used.
- name string
The Name of the agent.
- project string
ID or full path of the project maintained by the authenticated user.
- status string
The status of the token. Valid values are
active
,revoked
.- token string
The secret token for the agent. The
token
is not available in imported resources.- token
Id number The ID of the token.
- agent_
id int The ID of the agent.
- created_
at str The ISO8601 datetime when the agent was created.
- created_
by_ intuser_ id The ID of the user who created the agent.
- description str
The Description for the agent.
- last_
used_ strat The ISO8601 datetime when the token was last used.
- name str
The Name of the agent.
- project str
ID or full path of the project maintained by the authenticated user.
- status str
The status of the token. Valid values are
active
,revoked
.- token str
The secret token for the agent. The
token
is not available in imported resources.- token_
id int The ID of the token.
- agent
Id Number The ID of the agent.
- created
At String The ISO8601 datetime when the agent was created.
- created
By NumberUser Id The ID of the user who created the agent.
- description String
The Description for the agent.
- last
Used StringAt The ISO8601 datetime when the token was last used.
- name String
The Name of the agent.
- project String
ID or full path of the project maintained by the authenticated user.
- status String
The status of the token. Valid values are
active
,revoked
.- token String
The secret token for the agent. The
token
is not available in imported resources.- token
Id Number The ID of the token.
Import
A token for a GitLab Agent for Kubernetes can be imported with the following command and the id pattern <project>:<agent-id>:<token-id>
$ pulumi import gitlab:index/clusterAgentToken:ClusterAgentToken example '12345:42:1'
ATTENTIONthe token
resource attribute is not available for imported resources as this information cannot be read from the GitLab API.
Package Details
- Repository
- GitLab pulumi/pulumi-gitlab
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
gitlab
Terraform Provider.