← All packages

Rancher2

Pulumi Official

Package maintained by Pulumi

v3.8.0 published on Tuesday, May 31, 2022 by Pulumi

Source code

Bootstrap

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new rancher2_bootstrap
        var admin = new Rancher2.Bootstrap("admin", new Rancher2.BootstrapArgs
        {
            Password = "blahblah",
            Telemetry = true,
        });
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rancher2.NewBootstrap(ctx, "admin", &rancher2.BootstrapArgs{
			Password:  pulumi.String("blahblah"),
			Telemetry: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2_bootstrap
admin = rancher2.Bootstrap("admin",
    password="blahblah",
    telemetry=True)

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

// Create a new rancher2_bootstrap
const admin = new rancher2.Bootstrap("admin", {
    password: "blahblah",
    telemetry: true,
});

Coming soon!

Create a Bootstrap Resource

new Bootstrap(name: string, args?: BootstrapArgs, opts?: CustomResourceOptions);

@overload
def Bootstrap(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              initial_password: Optional[str] = None,
              password: Optional[str] = None,
              telemetry: Optional[bool] = None,
              token_ttl: Optional[int] = None,
              token_update: Optional[bool] = None,
              ui_default_landing: Optional[str] = None)
@overload
def Bootstrap(resource_name: str,
              args: Optional[BootstrapArgs] = None,
              opts: Optional[ResourceOptions] = None)

func NewBootstrap(ctx *Context, name string, args *BootstrapArgs, opts ...ResourceOption) (*Bootstrap, error)

public Bootstrap(string name, BootstrapArgs? args = null, CustomResourceOptions? opts = null)

public Bootstrap(String name, BootstrapArgs args)
public Bootstrap(String name, BootstrapArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args BootstrapArgs: 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 BootstrapArgs: 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 BootstrapArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BootstrapArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BootstrapArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

InitialPassword string: Initial password for Admin user. Default: admin (string)
Password string: Password for Admin user or random generated if empty (string)
Telemetry bool: Send telemetry anonymous data. Default: false (bool)
TokenTtl int: TTL in seconds for generated admin token. Default: 0 (int)
TokenUpdate bool: Regenerate admin token. Default: false (bool)
UiDefaultLanding string: Default UI landing for k8s clusters. Available options: ember (cluster manager ui) and vue (cluster explorer ui). Default: ember (string)

InitialPassword string: Initial password for Admin user. Default: admin (string)
Password string: Password for Admin user or random generated if empty (string)
Telemetry bool: Send telemetry anonymous data. Default: false (bool)
TokenTtl int: TTL in seconds for generated admin token. Default: 0 (int)
TokenUpdate bool: Regenerate admin token. Default: false (bool)
UiDefaultLanding string: Default UI landing for k8s clusters. Available options: ember (cluster manager ui) and vue (cluster explorer ui). Default: ember (string)

initialPassword String: Initial password for Admin user. Default: admin (string)
password String: Password for Admin user or random generated if empty (string)
telemetry Boolean: Send telemetry anonymous data. Default: false (bool)
tokenTtl Integer: TTL in seconds for generated admin token. Default: 0 (int)
tokenUpdate Boolean: Regenerate admin token. Default: false (bool)
uiDefaultLanding String: Default UI landing for k8s clusters. Available options: ember (cluster manager ui) and vue (cluster explorer ui). Default: ember (string)

initialPassword string: Initial password for Admin user. Default: admin (string)
password string: Password for Admin user or random generated if empty (string)
telemetry boolean: Send telemetry anonymous data. Default: false (bool)
tokenTtl number: TTL in seconds for generated admin token. Default: 0 (int)
tokenUpdate boolean: Regenerate admin token. Default: false (bool)
uiDefaultLanding string: Default UI landing for k8s clusters. Available options: ember (cluster manager ui) and vue (cluster explorer ui). Default: ember (string)

initial_password str: Initial password for Admin user. Default: admin (string)
password str: Password for Admin user or random generated if empty (string)
telemetry bool: Send telemetry anonymous data. Default: false (bool)
token_ttl int: TTL in seconds for generated admin token. Default: 0 (int)
token_update bool: Regenerate admin token. Default: false (bool)
ui_default_landing str: Default UI landing for k8s clusters. Available options: ember (cluster manager ui) and vue (cluster explorer ui). Default: ember (string)

initialPassword String: Initial password for Admin user. Default: admin (string)
password String: Password for Admin user or random generated if empty (string)
telemetry Boolean: Send telemetry anonymous data. Default: false (bool)
tokenTtl Number: TTL in seconds for generated admin token. Default: 0 (int)
tokenUpdate Boolean: Regenerate admin token. Default: false (bool)
uiDefaultLanding String: Default UI landing for k8s clusters. Available options: ember (cluster manager ui) and vue (cluster explorer ui). Default: ember (string)

Outputs

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

CurrentPassword string: (Computed/Sensitive) Current password for Admin user (string)
Id string: The provider-assigned unique ID for this managed resource.
TempToken string: (Computed) Generated API temporary token as helper. Should be empty (string)
TempTokenId string: (Computed) Generated API temporary token id as helper. Should be empty (string)
Token string: (Computed) Generated API token for Admin User (string)
TokenId string: (Computed) Generated API token id for Admin User (string)
Url string: (Computed) URL set as server-url (string)
User string: (Computed) Admin username (string)

CurrentPassword string: (Computed/Sensitive) Current password for Admin user (string)
Id string: The provider-assigned unique ID for this managed resource.
TempToken string: (Computed) Generated API temporary token as helper. Should be empty (string)
TempTokenId string: (Computed) Generated API temporary token id as helper. Should be empty (string)
Token string: (Computed) Generated API token for Admin User (string)
TokenId string: (Computed) Generated API token id for Admin User (string)
Url string: (Computed) URL set as server-url (string)
User string: (Computed) Admin username (string)

currentPassword String: (Computed/Sensitive) Current password for Admin user (string)
id String: The provider-assigned unique ID for this managed resource.
tempToken String: (Computed) Generated API temporary token as helper. Should be empty (string)
tempTokenId String: (Computed) Generated API temporary token id as helper. Should be empty (string)
token String: (Computed) Generated API token for Admin User (string)
tokenId String: (Computed) Generated API token id for Admin User (string)
url String: (Computed) URL set as server-url (string)
user String: (Computed) Admin username (string)

currentPassword string: (Computed/Sensitive) Current password for Admin user (string)
id string: The provider-assigned unique ID for this managed resource.
tempToken string: (Computed) Generated API temporary token as helper. Should be empty (string)
tempTokenId string: (Computed) Generated API temporary token id as helper. Should be empty (string)
token string: (Computed) Generated API token for Admin User (string)
tokenId string: (Computed) Generated API token id for Admin User (string)
url string: (Computed) URL set as server-url (string)
user string: (Computed) Admin username (string)

current_password str: (Computed/Sensitive) Current password for Admin user (string)
id str: The provider-assigned unique ID for this managed resource.
temp_token str: (Computed) Generated API temporary token as helper. Should be empty (string)
temp_token_id str: (Computed) Generated API temporary token id as helper. Should be empty (string)
token str: (Computed) Generated API token for Admin User (string)
token_id str: (Computed) Generated API token id for Admin User (string)
url str: (Computed) URL set as server-url (string)
user str: (Computed) Admin username (string)

currentPassword String: (Computed/Sensitive) Current password for Admin user (string)
id String: The provider-assigned unique ID for this managed resource.
tempToken String: (Computed) Generated API temporary token as helper. Should be empty (string)
tempTokenId String: (Computed) Generated API temporary token id as helper. Should be empty (string)
token String: (Computed) Generated API token for Admin User (string)
tokenId String: (Computed) Generated API token id for Admin User (string)
url String: (Computed) URL set as server-url (string)
user String: (Computed) Admin username (string)

Look up an Existing Bootstrap Resource

Get an existing Bootstrap 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?: BootstrapState, opts?: CustomResourceOptions): Bootstrap

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        current_password: Optional[str] = None,
        initial_password: Optional[str] = None,
        password: Optional[str] = None,
        telemetry: Optional[bool] = None,
        temp_token: Optional[str] = None,
        temp_token_id: Optional[str] = None,
        token: Optional[str] = None,
        token_id: Optional[str] = None,
        token_ttl: Optional[int] = None,
        token_update: Optional[bool] = None,
        ui_default_landing: Optional[str] = None,
        url: Optional[str] = None,
        user: Optional[str] = None) -> Bootstrap

func GetBootstrap(ctx *Context, name string, id IDInput, state *BootstrapState, opts ...ResourceOption) (*Bootstrap, error)

public static Bootstrap Get(string name, Input<string> id, BootstrapState? state, CustomResourceOptions? opts = null)

public static Bootstrap get(String name, Output<String> id, BootstrapState 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:

CurrentPassword string: (Computed/Sensitive) Current password for Admin user (string)
InitialPassword string: Initial password for Admin user. Default: admin (string)
Password string: Password for Admin user or random generated if empty (string)
Telemetry bool: Send telemetry anonymous data. Default: false (bool)
TempToken string: (Computed) Generated API temporary token as helper. Should be empty (string)
TempTokenId string: (Computed) Generated API temporary token id as helper. Should be empty (string)
Token string: (Computed) Generated API token for Admin User (string)
TokenId string: (Computed) Generated API token id for Admin User (string)
TokenTtl int: TTL in seconds for generated admin token. Default: 0 (int)
TokenUpdate bool: Regenerate admin token. Default: false (bool)
UiDefaultLanding string: Default UI landing for k8s clusters. Available options: ember (cluster manager ui) and vue (cluster explorer ui). Default: ember (string)
Url string: (Computed) URL set as server-url (string)
User string: (Computed) Admin username (string)

CurrentPassword string: (Computed/Sensitive) Current password for Admin user (string)
InitialPassword string: Initial password for Admin user. Default: admin (string)
Password string: Password for Admin user or random generated if empty (string)
Telemetry bool: Send telemetry anonymous data. Default: false (bool)
TempToken string: (Computed) Generated API temporary token as helper. Should be empty (string)
TempTokenId string: (Computed) Generated API temporary token id as helper. Should be empty (string)
Token string: (Computed) Generated API token for Admin User (string)
TokenId string: (Computed) Generated API token id for Admin User (string)
TokenTtl int: TTL in seconds for generated admin token. Default: 0 (int)
TokenUpdate bool: Regenerate admin token. Default: false (bool)
UiDefaultLanding string: Default UI landing for k8s clusters. Available options: ember (cluster manager ui) and vue (cluster explorer ui). Default: ember (string)
Url string: (Computed) URL set as server-url (string)
User string: (Computed) Admin username (string)

currentPassword String: (Computed/Sensitive) Current password for Admin user (string)
initialPassword String: Initial password for Admin user. Default: admin (string)
password String: Password for Admin user or random generated if empty (string)
telemetry Boolean: Send telemetry anonymous data. Default: false (bool)
tempToken String: (Computed) Generated API temporary token as helper. Should be empty (string)
tempTokenId String: (Computed) Generated API temporary token id as helper. Should be empty (string)
token String: (Computed) Generated API token for Admin User (string)
tokenId String: (Computed) Generated API token id for Admin User (string)
tokenTtl Integer: TTL in seconds for generated admin token. Default: 0 (int)
tokenUpdate Boolean: Regenerate admin token. Default: false (bool)
uiDefaultLanding String: Default UI landing for k8s clusters. Available options: ember (cluster manager ui) and vue (cluster explorer ui). Default: ember (string)
url String: (Computed) URL set as server-url (string)
user String: (Computed) Admin username (string)

currentPassword string: (Computed/Sensitive) Current password for Admin user (string)
initialPassword string: Initial password for Admin user. Default: admin (string)
password string: Password for Admin user or random generated if empty (string)
telemetry boolean: Send telemetry anonymous data. Default: false (bool)
tempToken string: (Computed) Generated API temporary token as helper. Should be empty (string)
tempTokenId string: (Computed) Generated API temporary token id as helper. Should be empty (string)
token string: (Computed) Generated API token for Admin User (string)
tokenId string: (Computed) Generated API token id for Admin User (string)
tokenTtl number: TTL in seconds for generated admin token. Default: 0 (int)
tokenUpdate boolean: Regenerate admin token. Default: false (bool)
uiDefaultLanding string: Default UI landing for k8s clusters. Available options: ember (cluster manager ui) and vue (cluster explorer ui). Default: ember (string)
url string: (Computed) URL set as server-url (string)
user string: (Computed) Admin username (string)

current_password str: (Computed/Sensitive) Current password for Admin user (string)
initial_password str: Initial password for Admin user. Default: admin (string)
password str: Password for Admin user or random generated if empty (string)
telemetry bool: Send telemetry anonymous data. Default: false (bool)
temp_token str: (Computed) Generated API temporary token as helper. Should be empty (string)
temp_token_id str: (Computed) Generated API temporary token id as helper. Should be empty (string)
token str: (Computed) Generated API token for Admin User (string)
token_id str: (Computed) Generated API token id for Admin User (string)
token_ttl int: TTL in seconds for generated admin token. Default: 0 (int)
token_update bool: Regenerate admin token. Default: false (bool)
ui_default_landing str: Default UI landing for k8s clusters. Available options: ember (cluster manager ui) and vue (cluster explorer ui). Default: ember (string)
url str: (Computed) URL set as server-url (string)
user str: (Computed) Admin username (string)

currentPassword String: (Computed/Sensitive) Current password for Admin user (string)
initialPassword String: Initial password for Admin user. Default: admin (string)
password String: Password for Admin user or random generated if empty (string)
telemetry Boolean: Send telemetry anonymous data. Default: false (bool)
tempToken String: (Computed) Generated API temporary token as helper. Should be empty (string)
tempTokenId String: (Computed) Generated API temporary token id as helper. Should be empty (string)
token String: (Computed) Generated API token for Admin User (string)
tokenId String: (Computed) Generated API token id for Admin User (string)
tokenTtl Number: TTL in seconds for generated admin token. Default: 0 (int)
tokenUpdate Boolean: Regenerate admin token. Default: false (bool)
uiDefaultLanding String: Default UI landing for k8s clusters. Available options: ember (cluster manager ui) and vue (cluster explorer ui). Default: ember (string)
url String: (Computed) URL set as server-url (string)
user String: (Computed) Admin username (string)

Package Details

Repository: https://github.com/pulumi/pulumi-rancher2
License: Apache-2.0
Notes: This Pulumi package is based on the rancher2 Terraform Provider.