Package @pulumi/rancher2

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-rancher2 repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-rancher2 repo.

var rancher2 = require("@pulumi/rancher2");
import * as rancher2 from "@pulumi/rancher2";

Modules

Resources

Data Sources

Others

Resources

Resource ActiveDirectory

class ActiveDirectory extends CustomResource

Provides a Rancher v2 Auth Config ActiveDirectory resource. This can be used to configure and enable Auth Config ActiveDirectory for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/auth_config_activedirectory.html.markdown.

constructor

new ActiveDirectory(name: string, args: ActiveDirectoryArgs, opts?: pulumi.CustomResourceOptions)

Create a ActiveDirectory resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ActiveDirectoryState, opts?: pulumi.CustomResourceOptions): ActiveDirectory

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ActiveDirectory

Returns true if the given object is an instance of ActiveDirectory. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessMode

public accessMode: pulumi.Output<string | undefined>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

public allowedPrincipalIds: pulumi.Output<string[] | undefined>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: activedirectory_user://<DN> activedirectory_group://<DN> (list)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

public certificate: pulumi.Output<string | undefined>;

CA certificate for TLS if selfsigned (string)

property connectionTimeout

public connectionTimeout: pulumi.Output<number | undefined>;

ActiveDirectory connection timeout. Default 5000 (int)

property defaultLoginDomain

public defaultLoginDomain: pulumi.Output<string | undefined>;

ActiveDirectory defult lgoin domain (string)

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

public groupDnAttribute: pulumi.Output<string>;

Group DN attribute. Default distinguishedName (string)

property groupMemberMappingAttribute

public groupMemberMappingAttribute: pulumi.Output<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

public groupMemberUserAttribute: pulumi.Output<string>;

Group member user attribute. Default distinguishedName (string)

property groupNameAttribute

public groupNameAttribute: pulumi.Output<string>;

Group name attribute. Default name (string)

property groupObjectClass

public groupObjectClass: pulumi.Output<string>;

Group object class. Default group (string)

property groupSearchAttribute

public groupSearchAttribute: pulumi.Output<string>;

Group search attribute. Default sAMAccountName (string)

property groupSearchBase

public groupSearchBase: pulumi.Output<string>;

Group search base (string)

property groupSearchFilter

public groupSearchFilter: pulumi.Output<string>;

Group search filter (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the resource (map)

property name

public name: pulumi.Output<string>;

(Computed) The name of the resource (string)

property nestedGroupMembershipEnabled

public nestedGroupMembershipEnabled: pulumi.Output<boolean>;

Nested group membership enable. Default false (bool)

property port

public port: pulumi.Output<number | undefined>;

ActiveDirectory port. Default 389 (int)

property servers

public servers: pulumi.Output<string[]>;

ActiveDirectory servers list (list)

property serviceAccountPassword

public serviceAccountPassword: pulumi.Output<string>;

Service account password for access ActiveDirectory service (string)

property serviceAccountUsername

public serviceAccountUsername: pulumi.Output<string>;

Service account DN for access ActiveDirectory service (string)

property tls

public tls: pulumi.Output<boolean>;

Enable TLS connection (bool)

property type

public type: pulumi.Output<string>;

(Computed) The type of the resource (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userDisabledBitMask

public userDisabledBitMask: pulumi.Output<number | undefined>;

User disabled bit mask. Default 2 (int)

property userEnabledAttribute

public userEnabledAttribute: pulumi.Output<string>;

User enable attribute (string)

property userLoginAttribute

public userLoginAttribute: pulumi.Output<string>;

User login attribute. Default sAMAccountName (string)

property userNameAttribute

public userNameAttribute: pulumi.Output<string>;

User name attribute. Default name (string)

property userObjectClass

public userObjectClass: pulumi.Output<string>;

User object class. Default person (string)

property userSearchAttribute

public userSearchAttribute: pulumi.Output<string>;

User search attribute. Default sAMAccountName|sn|givenName (string)

property userSearchBase

public userSearchBase: pulumi.Output<string>;

User search base DN (string)

property userSearchFilter

public userSearchFilter: pulumi.Output<string>;

User search filter (string)

Resource App

class App extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/app.html.markdown.

constructor

new App(name: string, args: AppArgs, opts?: pulumi.CustomResourceOptions)

Create a App resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AppState, opts?: pulumi.CustomResourceOptions): App

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is App

Returns true if the given object is an instance of App. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for App object (map)

property answers

public answers: pulumi.Output<{[key: string]: any} | undefined>;

Answers for the app template. If modified, app will be upgraded (map)

property catalogName

public catalogName: pulumi.Output<string>;

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs: * add cluster ID before name, c-XXXXX:<name> * add project ID before name, p-XXXXX:<name>

property description

public description: pulumi.Output<string>;

Description for the app (string)

property externalId

public externalId: pulumi.Output<string>;

(Computed) The url of the app template on a catalog (string)

property forceUpgrade

public forceUpgrade: pulumi.Output<boolean | undefined>;

Force app upgrade (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for App object (map)

property name

public name: pulumi.Output<string>;

The name of the app (string)

property projectId

public projectId: pulumi.Output<string>;

The project id where the app will be installed (string)

property revisionId

public revisionId: pulumi.Output<string>;

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revisionId (string)

property targetNamespace

public targetNamespace: pulumi.Output<string>;

The namespace name where the app will be installed (string)

property templateName

public templateName: pulumi.Output<string>;

Template name of the app. If modified, app will be upgraded (string)

property templateVersion

public templateVersion: pulumi.Output<string>;

Template version of the app. If modified, app will be upgraded. Default: latest (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property valuesYaml

public valuesYaml: pulumi.Output<string | undefined>;

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

Resource AuthConfigAdfs

class AuthConfigAdfs extends CustomResource

Provides a Rancher v2 Auth Config ADFS resource. This can be used to configure and enable Auth Config ADFS for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

Example Usage

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

// Create a new rancher2 Auth Config ADFS
const adfs = new rancher2.AuthConfigAdfs("adfs", {
    displayNameField: "<DISPLAY_NAME_FIELD>",
    groupsField: "<GROUPS_FIELD>",
    idpMetadataContent: "<IDP_METADATA_CONTENT>",
    rancherApiHost: "https://<RANCHER_API_HOST>",
    spCert: "<SP_CERT>",
    spKey: "<SP_KEY>",
    uidField: "<UID_FIELD>",
    userNameField: "<USER_NAME_FIELD>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/auth_config_adfs.html.markdown.

constructor

new AuthConfigAdfs(name: string, args: AuthConfigAdfsArgs, opts?: pulumi.CustomResourceOptions)

Create a AuthConfigAdfs resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthConfigAdfsState, opts?: pulumi.CustomResourceOptions): AuthConfigAdfs

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AuthConfigAdfs

Returns true if the given object is an instance of AuthConfigAdfs. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessMode

public accessMode: pulumi.Output<string | undefined>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

public allowedPrincipalIds: pulumi.Output<string[] | undefined>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

public displayNameField: pulumi.Output<string>;

ADFS display name field (string)

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Enable auth config provider. Default true (bool)

property groupsField

public groupsField: pulumi.Output<string>;

ADFS group field (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idpMetadataContent

public idpMetadataContent: pulumi.Output<string>;

ADFS IDP metadata content (string)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the resource (map)

property name

public name: pulumi.Output<string>;

(Computed) The name of the resource (string)

property rancherApiHost

public rancherApiHost: pulumi.Output<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

public spCert: pulumi.Output<string>;

ADFS SP cert (string)

property spKey

public spKey: pulumi.Output<string>;

ADFS SP key (string)

property type

public type: pulumi.Output<string>;

(Computed) The type of the resource (string)

property uidField

public uidField: pulumi.Output<string>;

ADFS UID field (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userNameField

public userNameField: pulumi.Output<string>;

ADFS user name field (string)

Resource AuthConfigAzureAd

class AuthConfigAzureAd extends CustomResource

Provides a Rancher v2 Auth Config AzureAD resource. This can be used to configure and enable Auth Config AzureAD for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

Example Usage

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

// Create a new rancher2 Auth Config AzureAD
const azuread = new rancher2.AuthConfigAzureAd("azuread", {
    applicationId: "<AZUREAD_APP_ID>",
    applicationSecret: "<AZUREAD_APP_SECRET>",
    authEndpoint: "<AZUREAD_AUTH_ENDPOINT>",
    graphEndpoint: "<AZUREAD_GRAPH_ENDPOINT>",
    rancherUrl: "<RANCHER_URL>",
    tenantId: "<AZUREAD_TENANT_ID>",
    tokenEndpoint: "<AZUREAD_TOKEN_ENDPOINT>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/auth_config_azuread.html.markdown.

constructor

new AuthConfigAzureAd(name: string, args: AuthConfigAzureAdArgs, opts?: pulumi.CustomResourceOptions)

Create a AuthConfigAzureAd resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthConfigAzureAdState, opts?: pulumi.CustomResourceOptions): AuthConfigAzureAd

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AuthConfigAzureAd

Returns true if the given object is an instance of AuthConfigAzureAd. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessMode

public accessMode: pulumi.Output<string | undefined>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

public allowedPrincipalIds: pulumi.Output<string[] | undefined>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: azuread_user://<USER_ID> azuread_group://<GROUP_ID> (list)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the resource (map)

property applicationId

public applicationId: pulumi.Output<string>;

AzureAD auth application ID (string)

property applicationSecret

public applicationSecret: pulumi.Output<string>;

AzureAD auth application secret (string)

property authEndpoint

public authEndpoint: pulumi.Output<string>;

AzureAD auth endpoint (string)

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Enable auth config provider. Default true (bool)

property endpoint

public endpoint: pulumi.Output<string | undefined>;

AzureAD endpoint. Default https://login.microsoftonline.com/ (string)

property graphEndpoint

public graphEndpoint: pulumi.Output<string>;

AzureAD graph endpoint (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the resource (map)

property name

public name: pulumi.Output<string>;

(Computed) The name of the resource (string)

property rancherUrl

public rancherUrl: pulumi.Output<string>;

Rancher URL (string). “/verify-auth-azure”

property tenantId

public tenantId: pulumi.Output<string>;

AzureAD tenant ID (string)

property tokenEndpoint

public tokenEndpoint: pulumi.Output<string>;

AzureAD token endpoint (string)

property type

public type: pulumi.Output<string>;

(Computed) The type of the resource (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource AuthConfigFreeIpa

class AuthConfigFreeIpa extends CustomResource

Provides a Rancher v2 Auth Config FreeIpa resource. This can be used to configure and enable Auth Config FreeIpa for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/auth_config_freeipa.html.markdown.

constructor

new AuthConfigFreeIpa(name: string, args: AuthConfigFreeIpaArgs, opts?: pulumi.CustomResourceOptions)

Create a AuthConfigFreeIpa resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthConfigFreeIpaState, opts?: pulumi.CustomResourceOptions): AuthConfigFreeIpa

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AuthConfigFreeIpa

Returns true if the given object is an instance of AuthConfigFreeIpa. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessMode

public accessMode: pulumi.Output<string | undefined>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

public allowedPrincipalIds: pulumi.Output<string[] | undefined>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: freeipa_user://<DN> freeipa_group://<DN> (list)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

public certificate: pulumi.Output<string | undefined>;

Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

property connectionTimeout

public connectionTimeout: pulumi.Output<number | undefined>;

FreeIpa connection timeout. Default 5000 (int)

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

public groupDnAttribute: pulumi.Output<string>;

Group DN attribute. Default entryDN (string)

property groupMemberMappingAttribute

public groupMemberMappingAttribute: pulumi.Output<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

public groupMemberUserAttribute: pulumi.Output<string>;

Group member user attribute. Default entryDN (string)

property groupNameAttribute

public groupNameAttribute: pulumi.Output<string>;

Group name attribute. Default cn (string)

property groupObjectClass

public groupObjectClass: pulumi.Output<string>;

Group object class. Default groupOfNames (string)

property groupSearchAttribute

public groupSearchAttribute: pulumi.Output<string>;

Group search attribute. Default cn (string)

property groupSearchBase

public groupSearchBase: pulumi.Output<string>;

Group search base (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the resource (map)

property name

public name: pulumi.Output<string>;

(Computed) The name of the resource (string)

property nestedGroupMembershipEnabled

public nestedGroupMembershipEnabled: pulumi.Output<boolean>;

Nested group membership enable. Default false (bool)

property port

public port: pulumi.Output<number | undefined>;

FreeIpa port. Default 389 (int)

property servers

public servers: pulumi.Output<string[]>;

FreeIpa servers list (list)

property serviceAccountDistinguishedName

public serviceAccountDistinguishedName: pulumi.Output<string>;

Service account DN for access FreeIpa service (string)

property serviceAccountPassword

public serviceAccountPassword: pulumi.Output<string>;

Service account password for access FreeIpa service (string)

property tls

public tls: pulumi.Output<boolean>;

Enable TLS connection (bool)

property type

public type: pulumi.Output<string>;

(Computed) The type of the resource (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userDisabledBitMask

public userDisabledBitMask: pulumi.Output<number>;

User disabled bit mask (int)

property userEnabledAttribute

public userEnabledAttribute: pulumi.Output<string>;

User enable attribute (string)

property userLoginAttribute

public userLoginAttribute: pulumi.Output<string>;

User login attribute. Default uid (string)

property userMemberAttribute

public userMemberAttribute: pulumi.Output<string>;

User member attribute. Default memberOf (string)

property userNameAttribute

public userNameAttribute: pulumi.Output<string>;

User name attribute. Default givenName (string)

property userObjectClass

public userObjectClass: pulumi.Output<string>;

User object class. Default inetorgperson (string)

property userSearchAttribute

public userSearchAttribute: pulumi.Output<string>;

User search attribute. Default uid|sn|givenName (string)

property userSearchBase

public userSearchBase: pulumi.Output<string>;

User search base DN (string)

Resource AuthConfigGithub

class AuthConfigGithub extends CustomResource

Provides a Rancher v2 Auth Config Github resource. This can be used to configure and enable Auth Config Github for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

Example Usage

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

// Create a new rancher2 Auth Config Github
const github = new rancher2.AuthConfigGithub("github", {
    clientId: "<GITHUB_CLIENT_ID>",
    clientSecret: "<GITHUB_CLIENT_SECRET>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/auth_config_github.html.markdown.

constructor

new AuthConfigGithub(name: string, args: AuthConfigGithubArgs, opts?: pulumi.CustomResourceOptions)

Create a AuthConfigGithub resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthConfigGithubState, opts?: pulumi.CustomResourceOptions): AuthConfigGithub

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AuthConfigGithub

Returns true if the given object is an instance of AuthConfigGithub. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessMode

public accessMode: pulumi.Output<string | undefined>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

public allowedPrincipalIds: pulumi.Output<string[] | undefined>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: github_user://<USER_ID> github_team://<GROUP_ID> github_org://<ORG_ID> (list)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the resource (map)

property clientId

public clientId: pulumi.Output<string>;

Github auth Client ID (string)

property clientSecret

public clientSecret: pulumi.Output<string>;

Github auth Client secret (string)

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Enable auth config provider. Default true (bool)

property hostname

public hostname: pulumi.Output<string | undefined>;

Github hostname to connect. Default github.com (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the resource (map)

property name

public name: pulumi.Output<string>;

(Computed) The name of the resource (string)

property tls

public tls: pulumi.Output<boolean | undefined>;

Enable TLS connection. Default true (bool)

property type

public type: pulumi.Output<string>;

(Computed) The type of the resource (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource AuthConfigKeycloak

class AuthConfigKeycloak extends CustomResource

Provides a Rancher v2 Auth Config KeyCloak resource. This can be used to configure and enable Auth Config KeyCloak for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

Example Usage

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

// Create a new rancher2 Auth Config KeyCloak
const keycloak = new rancher2.AuthConfigKeycloak("keycloak", {
    displayNameField: "<DISPLAY_NAME_FIELD>",
    groupsField: "<GROUPS_FIELD>",
    idpMetadataContent: "<IDP_METADATA_CONTENT>",
    rancherApiHost: "https://<RANCHER_API_HOST>",
    spCert: "<SP_CERT>",
    spKey: "<SP_KEY>",
    uidField: "<UID_FIELD>",
    userNameField: "<USER_NAME_FIELD>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/auth_config_keycloak.html.markdown.

constructor

new AuthConfigKeycloak(name: string, args: AuthConfigKeycloakArgs, opts?: pulumi.CustomResourceOptions)

Create a AuthConfigKeycloak resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthConfigKeycloakState, opts?: pulumi.CustomResourceOptions): AuthConfigKeycloak

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AuthConfigKeycloak

Returns true if the given object is an instance of AuthConfigKeycloak. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessMode

public accessMode: pulumi.Output<string | undefined>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

public allowedPrincipalIds: pulumi.Output<string[] | undefined>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

public displayNameField: pulumi.Output<string>;

KeyCloak display name field (string)

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Enable auth config provider. Default true (bool)

property groupsField

public groupsField: pulumi.Output<string>;

KeyCloak group field (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idpMetadataContent

public idpMetadataContent: pulumi.Output<string>;

KeyCloak IDP metadata content (string)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the resource (map)

property name

public name: pulumi.Output<string>;

(Computed) The name of the resource (string)

property rancherApiHost

public rancherApiHost: pulumi.Output<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

public spCert: pulumi.Output<string>;

KeyCloak SP cert (string)

property spKey

public spKey: pulumi.Output<string>;

KeyCloak SP key (string)

property type

public type: pulumi.Output<string>;

(Computed) The type of the resource (string)

property uidField

public uidField: pulumi.Output<string>;

KeyCloak UID field (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userNameField

public userNameField: pulumi.Output<string>;

KeyCloak user name field (string)

Resource AuthConfigOkta

class AuthConfigOkta extends CustomResource

Provides a Rancher v2 Auth Config OKTA resource. This can be used to configure and enable Auth Config OKTA for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

Example Usage

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

// Create a new rancher2 Auth Config OKTA
const okta = new rancher2.AuthConfigOkta("okta", {
    displayNameField: "<DISPLAY_NAME_FIELD>",
    groupsField: "<GROUPS_FIELD>",
    idpMetadataContent: "<IDP_METADATA_CONTENT>",
    rancherApiHost: "https://<RANCHER_API_HOST>",
    spCert: "<SP_CERT>",
    spKey: "<SP_KEY>",
    uidField: "<UID_FIELD>",
    userNameField: "<USER_NAME_FIELD>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/auth_config_okta.html.markdown.

constructor

new AuthConfigOkta(name: string, args: AuthConfigOktaArgs, opts?: pulumi.CustomResourceOptions)

Create a AuthConfigOkta resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthConfigOktaState, opts?: pulumi.CustomResourceOptions): AuthConfigOkta

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AuthConfigOkta

Returns true if the given object is an instance of AuthConfigOkta. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessMode

public accessMode: pulumi.Output<string | undefined>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

public allowedPrincipalIds: pulumi.Output<string[] | undefined>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: okta_user://<USER_ID> okta_group://<GROUP_ID> (list)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

public displayNameField: pulumi.Output<string>;

OKTA display name field (string)

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Enable auth config provider. Default true (bool)

property groupsField

public groupsField: pulumi.Output<string>;

OKTA group field (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idpMetadataContent

public idpMetadataContent: pulumi.Output<string>;

OKTA IDP metadata content (string)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the resource (map)

property name

public name: pulumi.Output<string>;

(Computed) The name of the resource (string)

property rancherApiHost

public rancherApiHost: pulumi.Output<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

public spCert: pulumi.Output<string>;

OKTA SP cert (string)

property spKey

public spKey: pulumi.Output<string>;

OKTA SP key (string)

property type

public type: pulumi.Output<string>;

(Computed) The type of the resource (string)

property uidField

public uidField: pulumi.Output<string>;

OKTA UID field (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userNameField

public userNameField: pulumi.Output<string>;

OKTA user name field (string)

Resource AuthConfigOpenLdap

class AuthConfigOpenLdap extends CustomResource

Provides a Rancher v2 Auth Config OpenLdap resource. This can be used to configure and enable Auth Config OpenLdap for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/auth_config_openldap.html.markdown.

constructor

new AuthConfigOpenLdap(name: string, args: AuthConfigOpenLdapArgs, opts?: pulumi.CustomResourceOptions)

Create a AuthConfigOpenLdap resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthConfigOpenLdapState, opts?: pulumi.CustomResourceOptions): AuthConfigOpenLdap

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AuthConfigOpenLdap

Returns true if the given object is an instance of AuthConfigOpenLdap. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessMode

public accessMode: pulumi.Output<string | undefined>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

public allowedPrincipalIds: pulumi.Output<string[] | undefined>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

public certificate: pulumi.Output<string | undefined>;

Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

property connectionTimeout

public connectionTimeout: pulumi.Output<number | undefined>;

OpenLdap connection timeout. Default 5000 (int)

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

public groupDnAttribute: pulumi.Output<string>;

Group DN attribute. Default entryDN (string)

property groupMemberMappingAttribute

public groupMemberMappingAttribute: pulumi.Output<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

public groupMemberUserAttribute: pulumi.Output<string>;

Group member user attribute. Default entryDN (string)

property groupNameAttribute

public groupNameAttribute: pulumi.Output<string>;

Group name attribute. Default cn (string)

property groupObjectClass

public groupObjectClass: pulumi.Output<string>;

Group object class. Default groupOfNames (string)

property groupSearchAttribute

public groupSearchAttribute: pulumi.Output<string>;

Group search attribute. Default cn (string)

property groupSearchBase

public groupSearchBase: pulumi.Output<string>;

Group search base (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the resource (map)

property name

public name: pulumi.Output<string>;

(Computed) The name of the resource (string)

property nestedGroupMembershipEnabled

public nestedGroupMembershipEnabled: pulumi.Output<boolean>;

Nested group membership enable. Default false (bool)

property port

public port: pulumi.Output<number | undefined>;

OpenLdap port. Default 389 (int)

property servers

public servers: pulumi.Output<string[]>;

OpenLdap servers list (list)

property serviceAccountDistinguishedName

public serviceAccountDistinguishedName: pulumi.Output<string>;

Service account DN for access OpenLdap service (string)

property serviceAccountPassword

public serviceAccountPassword: pulumi.Output<string>;

Service account password for access OpenLdap service (string)

property tls

public tls: pulumi.Output<boolean>;

Enable TLS connection (bool)

property type

public type: pulumi.Output<string>;

(Computed) The type of the resource (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userDisabledBitMask

public userDisabledBitMask: pulumi.Output<number>;

User disabled bit mask (int)

property userEnabledAttribute

public userEnabledAttribute: pulumi.Output<string>;

User enable attribute (string)

property userLoginAttribute

public userLoginAttribute: pulumi.Output<string>;

User login attribute. Default uid (string)

property userMemberAttribute

public userMemberAttribute: pulumi.Output<string>;

User member attribute. Default memberOf (string)

property userNameAttribute

public userNameAttribute: pulumi.Output<string>;

User name attribute. Default givenName (string)

property userObjectClass

public userObjectClass: pulumi.Output<string>;

User object class. Default inetorgperson (string)

property userSearchAttribute

public userSearchAttribute: pulumi.Output<string>;

User search attribute. Default uid|sn|givenName (string)

property userSearchBase

public userSearchBase: pulumi.Output<string>;

User search base DN (string)

Resource AuthConfigPing

class AuthConfigPing extends CustomResource

Provides a Rancher v2 Auth Config Ping resource. This can be used to configure and enable Auth Config Ping for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

Example Usage

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

// Create a new rancher2 Auth Config Ping
const ping = new rancher2.AuthConfigPing("ping", {
    displayNameField: "<DISPLAY_NAME_FIELD>",
    groupsField: "<GROUPS_FIELD>",
    idpMetadataContent: "<IDP_METADATA_CONTENT>",
    rancherApiHost: "https://<RANCHER_API_HOST>",
    spCert: "<SP_CERT>",
    spKey: "<SP_KEY>",
    uidField: "<UID_FIELD>",
    userNameField: "<USER_NAME_FIELD>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/auth_config_ping.html.markdown.

constructor

new AuthConfigPing(name: string, args: AuthConfigPingArgs, opts?: pulumi.CustomResourceOptions)

Create a AuthConfigPing resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthConfigPingState, opts?: pulumi.CustomResourceOptions): AuthConfigPing

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AuthConfigPing

Returns true if the given object is an instance of AuthConfigPing. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessMode

public accessMode: pulumi.Output<string | undefined>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

public allowedPrincipalIds: pulumi.Output<string[] | undefined>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

public displayNameField: pulumi.Output<string>;

Ping display name field (string)

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Enable auth config provider. Default true (bool)

property groupsField

public groupsField: pulumi.Output<string>;

Ping group field (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idpMetadataContent

public idpMetadataContent: pulumi.Output<string>;

Ping IDP metadata content (string)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the resource (map)

property name

public name: pulumi.Output<string>;

(Computed) The name of the resource (string)

property rancherApiHost

public rancherApiHost: pulumi.Output<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

public spCert: pulumi.Output<string>;

Ping SP cert (string)

property spKey

public spKey: pulumi.Output<string>;

Ping SP key (string)

property type

public type: pulumi.Output<string>;

(Computed) The type of the resource (string)

property uidField

public uidField: pulumi.Output<string>;

Ping UID field (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userNameField

public userNameField: pulumi.Output<string>;

Ping user name field (string)

Resource Bootstrap

class Bootstrap extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/bootstrap.html.markdown.

constructor

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

Create a Bootstrap resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BootstrapState, opts?: pulumi.CustomResourceOptions): Bootstrap

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Bootstrap

Returns true if the given object is an instance of Bootstrap. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property currentPassword

public currentPassword: pulumi.Output<string>;

Current password for Admin user. Just needed for recover if admin password has been changed from other resources and token is expired (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property password

public password: pulumi.Output<string>;

Password for Admin user or random generated if empty (string)

property telemetry

public telemetry: pulumi.Output<boolean | undefined>;

Send telemetry anonymous data. Default: false (bool)

property tempToken

public tempToken: pulumi.Output<string>;

(Computed) Generated API temporary token as helper. Should be empty (string)

property tempTokenId

public tempTokenId: pulumi.Output<string>;

(Computed) Generated API temporary token id as helper. Should be empty (string)

property token

public token: pulumi.Output<string>;

(Computed) Generated API token for Admin User (string)

property tokenId

public tokenId: pulumi.Output<string>;

(Computed) Generated API token id for Admin User (string)

property tokenTtl

public tokenTtl: pulumi.Output<number | undefined>;

TTL in seconds for generated admin token. Default: 0 (int)

property tokenUpdate

public tokenUpdate: pulumi.Output<boolean | undefined>;

Regenerate admin token. Default: false (bool)

property url

public url: pulumi.Output<string>;

(Computed) URL set as server-url (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property user

public user: pulumi.Output<string>;

(Computed) Admin username (string)

Resource Catalog

class Catalog extends CustomResource

Provides a Rancher v2 Catalog resource. This can be used to create cluster, global and/or project catalogs for Rancher v2 environments and retrieve their information.

Example Usage

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

// Create a new Rancher2 Global Catalog
const fooGlobal = new rancher2.Catalog("foo-global", {
    url: "https://<CATALOG_URL>",
});
// Create a new Rancher2 Cluster Catalog
const fooCluster = new rancher2.Catalog("foo-cluster", {
    scope: "cluster",
    url: "https://<CATALOG_URL>",
});
// Create a new Rancher2 Project Catalog
const fooProject = new rancher2.Catalog("foo-project", {
    scope: "project",
    url: "https://<CATALOG_URL>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/catalog.html.markdown.

constructor

new Catalog(name: string, args: CatalogArgs, opts?: pulumi.CustomResourceOptions)

Create a Catalog resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CatalogState, opts?: pulumi.CustomResourceOptions): Catalog

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Catalog

Returns true if the given object is an instance of Catalog. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for the catalog (map)

property branch

public branch: pulumi.Output<string | undefined>;

The branch of the catalog repo to use. Default master (string)

property clusterId

public clusterId: pulumi.Output<string | undefined>;

The cluster id of the catalog. Mandatory if scope = cluster (string)

property description

public description: pulumi.Output<string | undefined>;

A catalog description (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<string | undefined>;

The kind of the catalog. Just helm by the moment (string)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for the catalog (map)

property name

public name: pulumi.Output<string>;

The name of the catalog (string)

property password

public password: pulumi.Output<string | undefined>;

The password to access the catalog if needed (string)

property projectId

public projectId: pulumi.Output<string | undefined>;

The project id of the catalog. Mandatory if scope = project (string)

property scope

public scope: pulumi.Output<string | undefined>;

The scope of the catalog. cluster, global, and project are supported. Default global (string)

property url

public url: pulumi.Output<string>;

The url of the catalog repo (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string | undefined>;

The username to access the catalog if needed (string)

Resource Certificate

class Certificate extends CustomResource

Provides a Rancher v2 certificate resource. This can be used to create certificates for Rancher v2 environments and retrieve their information.

There are 2 types of Rancher v2 certificates: - Project certificate: Available to all namespaces in the projectId - Namespaced certificate: Available to just namespaceId in the projectId

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/certificate.html.markdown.

constructor

new Certificate(name: string, args: CertificateArgs, opts?: pulumi.CustomResourceOptions)

Create a Certificate resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CertificateState, opts?: pulumi.CustomResourceOptions): Certificate

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Certificate

Returns true if the given object is an instance of Certificate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for certificate object (map)

property certs

public certs: pulumi.Output<string>;

Base64 encoded public certs (string)

property description

public description: pulumi.Output<string | undefined>;

A certificate description (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property key

public key: pulumi.Output<string>;

Base64 encoded private key (string)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for certificate object (map)

property name

public name: pulumi.Output<string>;

The name of the certificate (string)

property namespaceId

public namespaceId: pulumi.Output<string | undefined>;

The namespace id where the namespaced certificate should be created (string)

property projectId

public projectId: pulumi.Output<string>;

The project id where the certificate should be created (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource CloudCredential

class CloudCredential extends CustomResource

Provides a Rancher v2 Cloud Credential resource. This can be used to create Cloud Credential for Rancher v2.2.x and retrieve their information.

amazonec2, azure, digitalocean, openstack and vsphere credentials config are supported for Cloud Credential.

Example Usage

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

// Create a new rancher2 Cloud Credential
const foo = new rancher2.CloudCredential("foo", {
    amazonec2CredentialConfig: {
        accessKey: "<AWS_ACCESS_KEY>",
        secretKey: "<AWS_SECRET_KEY>",
    },
    description: "foo test",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/cloud_credential.html.markdown.

constructor

new CloudCredential(name: string, args?: CloudCredentialArgs, opts?: pulumi.CustomResourceOptions)

Create a CloudCredential resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CloudCredentialState, opts?: pulumi.CustomResourceOptions): CloudCredential

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CloudCredential

Returns true if the given object is an instance of CloudCredential. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property amazonec2CredentialConfig

public amazonec2CredentialConfig: pulumi.Output<CloudCredentialAmazonec2CredentialConfig | undefined>;

AWS config for the Cloud Credential (list maxitems:1)

property annotations

public annotations: pulumi.Output<{[key: string]: any} | undefined>;

Annotations for Cloud Credential object (map)

property azureCredentialConfig

public azureCredentialConfig: pulumi.Output<CloudCredentialAzureCredentialConfig | undefined>;

Azure config for the Cloud Credential (list maxitems:1)

property description

public description: pulumi.Output<string | undefined>;

Description for the Cloud Credential (string)

property digitaloceanCredentialConfig

public digitaloceanCredentialConfig: pulumi.Output<CloudCredentialDigitaloceanCredentialConfig | undefined>;

DigitalOcean config for the Cloud Credential (list maxitems:1)

property driver

public driver: pulumi.Output<string>;

(Computed) The driver of the Cloud Credential (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for Cloud Credential object (map)

property name

public name: pulumi.Output<string>;

The name of the Cloud Credential (string)

property openstackCredentialConfig

public openstackCredentialConfig: pulumi.Output<CloudCredentialOpenstackCredentialConfig | undefined>;

OpenStack config for the Cloud Credential (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vsphereCredentialConfig

public vsphereCredentialConfig: pulumi.Output<CloudCredentialVsphereCredentialConfig | undefined>;

vSphere config for the Cloud Credential (list maxitems:1)

Resource Cluster

class Cluster extends CustomResource

Provides a Rancher v2 Cluster resource. This can be used to create Clusters for Rancher v2 environments and retrieve their information.

Example Usage

Creating Rancher v2 imported cluster

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

// Create a new rancher2 imported Cluster
const fooImported = new rancher2.Cluster("foo-imported", {
    description: "Foo rancher2 imported cluster",
});

Creating Rancher v2 RKE cluster

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

// Create a new rancher2 RKE Cluster
const fooCustom = new rancher2.Cluster("foo-custom", {
    description: "Foo rancher2 custom cluster",
    rkeConfig: {
        network: {
            plugin: "canal",
        },
    },
});

Creating Rancher v2 RKE cluster enabling and customizing monitoring

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

// Create a new rancher2 RKE Cluster
const fooCustom = new rancher2.Cluster("foo-custom", {
    clusterMonitoringInput: {
        answers: {
            "exporter-kubelets.https": true,
            "exporter-node.enabled": true,
            "exporter-node.ports.metrics.port": 9796,
            "exporter-node.resources.limits.cpu": "200m",
            "exporter-node.resources.limits.memory": "200Mi",
            "grafana.persistence.enabled": false,
            "grafana.persistence.size": "10Gi",
            "grafana.persistence.storageClass": "default",
            "operator.resources.limits.memory": "500Mi",
            "prometheus.persistence.enabled": "false",
            "prometheus.persistence.size": "50Gi",
            "prometheus.persistence.storageClass": "default",
            "prometheus.persistent.useReleaseName": "true",
            "prometheus.resources.core.limits.cpu": "1000m",
            "prometheus.resources.core.limits.memory": "1500Mi",
            "prometheus.resources.core.requests.cpu": "750m",
            "prometheus.resources.core.requests.memory": "750Mi",
            "prometheus.retention": "12h",
        },
    },
    description: "Foo rancher2 custom cluster",
    enableClusterMonitoring: true,
    rkeConfig: {
        network: {
            plugin: "canal",
        },
    },
});

Creating Rancher v2 RKE cluster assigning a node pool (overlapped planes)

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

// Create a new rancher2 RKE Cluster
const fooCustom = new rancher2.Cluster("foo-custom", {
    description: "Foo rancher2 custom cluster",
    rkeConfig: {
        network: {
            plugin: "canal",
        },
    },
});
// Create a new rancher2 Node Template
const fooNodeTemplate = new rancher2.NodeTemplate("foo", {
    amazonec2Config: {
        accessKey: "AWS_ACCESS_KEY",
        ami: "<AMI_ID>",
        region: "<REGION>",
        secretKey: "<AWS_SECRET_KEY>",
        securityGroups: ["<AWS_SECURITY_GROUP>"],
        subnetId: "<SUBNET_ID>",
        vpcId: "<VPC_ID>",
        zone: "<ZONE>",
    },
    description: "foo test",
});
// Create a new rancher2 Node Pool
const fooNodePool = new rancher2.NodePool("foo", {
    clusterId: foo_custom.id,
    controlPlane: true,
    etcd: true,
    hostnamePrefix: "foo-cluster-0",
    nodeTemplateId: fooNodeTemplate.id,
    quantity: 3,
    worker: true,
});

Creating Rancher v2 RKE cluster from template. For Rancher v2.3.x or above.

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

// Create a new rancher2 cluster template
const fooClusterTemplate = new rancher2.ClusterTemplate("foo", {
    description: "Test cluster template v2",
    members: [{
        accessType: "owner",
        userPrincipalId: "local://user-XXXXX",
    }],
    templateRevisions: [{
        clusterConfig: {
            rkeConfig: {
                network: {
                    plugin: "canal",
                },
                services: {
                    etcd: {
                        creation: "6h",
                        retention: "24h",
                    },
                },
            },
        },
        default: true,
        name: "V1",
    }],
});
// Create a new rancher2 RKE Cluster from template
const fooCluster = new rancher2.Cluster("foo", {
    clusterTemplateId: fooClusterTemplate.id,
    clusterTemplateRevisionId: fooClusterTemplate.defaultRevisionId,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/cluster.html.markdown.

constructor

new Cluster(name: string, args?: ClusterArgs, opts?: pulumi.CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterState, opts?: pulumi.CustomResourceOptions): Cluster

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Cluster

Returns true if the given object is an instance of Cluster. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property aksConfig

public aksConfig: pulumi.Output<ClusterAksConfig | undefined>;

The Azure AKS configuration for aks Clusters. Conflicts with eksConfig, gkeConfig and rkeConfig (list maxitems:1)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for cluster registration token object (map)

property clusterAuthEndpoint

public clusterAuthEndpoint: pulumi.Output<ClusterClusterAuthEndpoint>;

Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

property clusterMonitoringInput

public clusterMonitoringInput: pulumi.Output<ClusterClusterMonitoringInput>;

Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)

property clusterRegistrationToken

public clusterRegistrationToken: pulumi.Output<ClusterClusterRegistrationToken>;

(Computed) Cluster Registration Token generated for the cluster (list maxitems:1)

property clusterTemplateAnswers

public clusterTemplateAnswers: pulumi.Output<ClusterClusterTemplateAnswers | undefined>;

Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)

property clusterTemplateId

public clusterTemplateId: pulumi.Output<string | undefined>;

Cluster template ID. Just for Rancher v2.3.x and above (string)

property clusterTemplateQuestions

public clusterTemplateQuestions: pulumi.Output<ClusterClusterTemplateQuestion[] | undefined>;

Cluster template questions. Just for Rancher v2.3.x and above (list)

property clusterTemplateRevisionId

public clusterTemplateRevisionId: pulumi.Output<string | undefined>;

Cluster template revision ID. Just for Rancher v2.3.x and above (string)

property defaultPodSecurityPolicyTemplateId

public defaultPodSecurityPolicyTemplateId: pulumi.Output<string>;

Default pod security policy template id (string)

property defaultProjectId

public defaultProjectId: pulumi.Output<string>;

(Computed) Default project ID for the cluster (string)

property description

public description: pulumi.Output<string | undefined>;

An optional description of this cluster (string)

property desiredAgentImage

public desiredAgentImage: pulumi.Output<string>;

Desired agent image. Just for Rancher v2.3.x and above (string)

property desiredAuthImage

public desiredAuthImage: pulumi.Output<string>;

Desired auth image. Just for Rancher v2.3.x and above (string)

property dockerRootDir

public dockerRootDir: pulumi.Output<string>;

Desired auth image. Just for Rancher v2.3.x and above (string)

property driver

public driver: pulumi.Output<string>;

(Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)

property eksConfig

public eksConfig: pulumi.Output<ClusterEksConfig | undefined>;

The Amazon EKS configuration for eks Clusters. Conflicts with aksConfig, gkeConfig and rkeConfig (list maxitems:1)

property enableClusterAlerting

public enableClusterAlerting: pulumi.Output<boolean | undefined>;

Enable built-in cluster alerting. Default false (bool)

property enableClusterIstio

public enableClusterIstio: pulumi.Output<boolean | undefined>;

Enable built-in cluster istio. Default false. Just for Rancher v2.3.x and above (bool)

property enableClusterMonitoring

public enableClusterMonitoring: pulumi.Output<boolean | undefined>;

Enable built-in cluster monitoring. Default false (bool)

property enableNetworkPolicy

public enableNetworkPolicy: pulumi.Output<boolean | undefined>;

Enable project network isolation. Default false (bool)

property gkeConfig

public gkeConfig: pulumi.Output<ClusterGkeConfig | undefined>;

The Google GKE configuration for gke Clusters. Conflicts with aksConfig, eksConfig and rkeConfig (list maxitems:1)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kubeConfig

public kubeConfig: pulumi.Output<string>;

(Computed) Kube Config generated for the cluster (string)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for cluster registration token object (map)

property name

public name: pulumi.Output<string>;

Name of cluster registration token (string)

property rkeConfig

public rkeConfig: pulumi.Output<ClusterRkeConfig>;

The RKE configuration for rke Clusters. Conflicts with aksConfig, eksConfig and gkeConfig (list maxitems:1)

property systemProjectId

public systemProjectId: pulumi.Output<string>;

(Computed) System project ID for the cluster (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterAlterGroup

class ClusterAlterGroup extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/cluster_alert_group.html.markdown.

constructor

new ClusterAlterGroup(name: string, args: ClusterAlterGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterAlterGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterAlterGroupState, opts?: pulumi.CustomResourceOptions): ClusterAlterGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterAlterGroup

Returns true if the given object is an instance of ClusterAlterGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

The cluster alert group annotations (map)

property clusterId

public clusterId: pulumi.Output<string>;

The cluster id where create cluster alert group (string)

property description

public description: pulumi.Output<string | undefined>;

The cluster alert group description (string)

property groupIntervalSeconds

public groupIntervalSeconds: pulumi.Output<number | undefined>;

The cluster alert group interval seconds. Default: 180 (int)

property groupWaitSeconds

public groupWaitSeconds: pulumi.Output<number | undefined>;

The cluster alert group wait seconds. Default: 180 (int)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

The cluster alert group labels (map)

property name

public name: pulumi.Output<string>;

The cluster alert group name (string)

property recipients

public recipients: pulumi.Output<ClusterAlterGroupRecipient[] | undefined>;

The cluster alert group recipients (list)

property repeatIntervalSeconds

public repeatIntervalSeconds: pulumi.Output<number | undefined>;

The cluster alert group wait seconds. Default: 3600 (int)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterAlterRule

class ClusterAlterRule extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/cluster_alert_rule.html.markdown.

constructor

new ClusterAlterRule(name: string, args: ClusterAlterRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterAlterRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterAlterRuleState, opts?: pulumi.CustomResourceOptions): ClusterAlterRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterAlterRule

Returns true if the given object is an instance of ClusterAlterRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

The cluster alert rule annotations (map)

property clusterId

public clusterId: pulumi.Output<string>;

The cluster id where create cluster alert rule (string)

property eventRule

public eventRule: pulumi.Output<ClusterAlterRuleEventRule | undefined>;

The cluster alert rule event rule. ConflictsWith: "metricRule", "nodeRule", "systemServiceRule"` (list Maxitems:1)

property groupId

public groupId: pulumi.Output<string>;

The cluster alert rule alert group ID (string)

property groupIntervalSeconds

public groupIntervalSeconds: pulumi.Output<number | undefined>;

The cluster alert rule group interval seconds. Default: 180 (int)

property groupWaitSeconds

public groupWaitSeconds: pulumi.Output<number | undefined>;

The cluster alert rule group wait seconds. Default: 180 (int)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property inherited

public inherited: pulumi.Output<boolean | undefined>;

The cluster alert rule inherited. Default: true (bool)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

The cluster alert rule labels (map)

property metricRule

public metricRule: pulumi.Output<ClusterAlterRuleMetricRule | undefined>;

The cluster alert rule metric rule. ConflictsWith: "eventRule", "nodeRule", "systemServiceRule"` (list Maxitems:1)

property name

public name: pulumi.Output<string>;

The cluster alert rule name (string)

property nodeRule

public nodeRule: pulumi.Output<ClusterAlterRuleNodeRule | undefined>;

The cluster alert rule node rule. ConflictsWith: "eventRule", "metricRule", "systemServiceRule"` (list Maxitems:1)

property repeatIntervalSeconds

public repeatIntervalSeconds: pulumi.Output<number | undefined>;

The cluster alert rule wait seconds. Default: 3600 (int)

property severity

public severity: pulumi.Output<string | undefined>;

The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

property systemServiceRule

public systemServiceRule: pulumi.Output<ClusterAlterRuleSystemServiceRule | undefined>;

The cluster alert rule system service rule. ConflictsWith: "eventRule", "metricRule", "nodeRule"` (list Maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterDriver

class ClusterDriver extends CustomResource

Provides a Rancher v2 Cluster Driver resource. This can be used to create Cluster Driver for Rancher v2.2.x Kontainer Engine clusters and retrieve their information.

Example Usage

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

// Create a new Rancher2 Cluster Driver
const foo = new rancher2.ClusterDriver("foo", {
    active: true,
    builtin: false,
    checksum: "0x0",
    description: "Foo description",
    externalId: "fooExternal",
    uiUrl: "local://ui",
    url: "local://",
    whitelistDomains: ["*.foo.com"],
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/cluster_driver.html.markdown.

constructor

new ClusterDriver(name: string, args: ClusterDriverArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterDriver resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterDriverState, opts?: pulumi.CustomResourceOptions): ClusterDriver

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterDriver

Returns true if the given object is an instance of ClusterDriver. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property active

public active: pulumi.Output<boolean>;

Specify the cluster driver state (bool)

property actualUrl

public actualUrl: pulumi.Output<string | undefined>;

Actual url of the cluster driver (string)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the resource (map)

property builtin

public builtin: pulumi.Output<boolean>;

Specify whether the cluster driver is an internal cluster driver or not (bool)

property checksum

public checksum: pulumi.Output<string | undefined>;

Verify that the downloaded driver matches the expected checksum (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the resource (map)

property name

public name: pulumi.Output<string>;

Name of the cluster driver (string)

property uiUrl

public uiUrl: pulumi.Output<string | undefined>;

The URL to load for customized Add Clusters screen for this driver (string)

property url

public url: pulumi.Output<string>;

The URL to download the machine driver binary for 64-bit Linux (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property whitelistDomains

public whitelistDomains: pulumi.Output<string[] | undefined>;

Domains to whitelist for the ui (list)

Resource ClusterLogging

class ClusterLogging extends CustomResource

Provides a Rancher v2 Cluster Logging resource. This can be used to configure Cluster Logging for Rancher v2 environments and retrieve their information.

Example Usage

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

// Create a new Rancher2 Cluster Logging
const foo = new rancher2.ClusterLogging("foo", {
    clusterId: "<cluster_id>",
    kind: "syslog",
    syslogConfig: {
        endpoint: "<syslog_endpoint>",
        protocol: "udp",
        severity: "notice",
        sslVerify: false,
    },
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/cluster_logging.html.markdown.

constructor

new ClusterLogging(name: string, args: ClusterLoggingArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterLogging resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterLoggingState, opts?: pulumi.CustomResourceOptions): ClusterLogging

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterLogging

Returns true if the given object is an instance of ClusterLogging. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for Cluster Logging object (map)

property clusterId

public clusterId: pulumi.Output<string>;

The cluster id to configure logging (string)

property elasticsearchConfig

public elasticsearchConfig: pulumi.Output<ClusterLoggingElasticsearchConfig | undefined>;

The elasticsearch config for Cluster Logging. For kind = elasticsearch. Conflicts with fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property fluentdConfig

public fluentdConfig: pulumi.Output<ClusterLoggingFluentdConfig | undefined>;

The fluentd config for Cluster Logging. For kind = fluentd. Conflicts with elasticsearchConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kafkaConfig

public kafkaConfig: pulumi.Output<ClusterLoggingKafkaConfig | undefined>;

The kafka config for Cluster Logging. For kind = kafka. Conflicts with elasticsearchConfig, fluentdConfig, splunkConfig and syslogConfig (list maxitems:1)

property kind

public kind: pulumi.Output<string>;

The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for Cluster Logging object (map)

property name

public name: pulumi.Output<string>;

The name of the cluster logging config (string)

property namespaceId

public namespaceId: pulumi.Output<string | undefined>;

The namespace id from cluster logging (string)

property outputFlushInterval

public outputFlushInterval: pulumi.Output<number | undefined>;

How often buffered logs would be flushed. Default: 3 seconds (int)

property outputTags

public outputTags: pulumi.Output<{[key: string]: any}>;

The output tags for Cluster Logging (map)

property splunkConfig

public splunkConfig: pulumi.Output<ClusterLoggingSplunkConfig | undefined>;

The splunk config for Cluster Logging. For kind = splunk. Conflicts with elasticsearchConfig, fluentdConfig, kafkaConfig, and syslogConfig (list maxitems:1)

property syslogConfig

public syslogConfig: pulumi.Output<ClusterLoggingSyslogConfig | undefined>;

The syslog config for Cluster Logging. For kind = syslog. Conflicts with elasticsearchConfig, fluentdConfig, kafkaConfig, and splunkConfig (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterRoleTemplateBinding

class ClusterRoleTemplateBinding extends CustomResource

Provides a Rancher v2 Cluster Role Template Binding resource. This can be used to create Cluster Role Template Bindings for Rancher v2 environments and retrieve their information.

Example Usage

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

// Create a new Rancher2 Cluster Role Template Binding
const foo = new rancher2.ClusterRoleTemplateBinding("foo", {
    clusterId: "<cluster_id>",
    roleTemplateId: "<role_template_id>",
    userId: "<user_id>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/cluster_role_template_binding.html.markdown.

constructor

new ClusterRoleTemplateBinding(name: string, args: ClusterRoleTemplateBindingArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterRoleTemplateBinding resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterRoleTemplateBindingState, opts?: pulumi.CustomResourceOptions): ClusterRoleTemplateBinding

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterRoleTemplateBinding

Returns true if the given object is an instance of ClusterRoleTemplateBinding. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for cluster role template binding (map)

property clusterId

public clusterId: pulumi.Output<string>;

The cluster id where bind cluster role template binding (string)

property groupId

public groupId: pulumi.Output<string | undefined>;

The group ID to assign cluster role template binding (string)

property groupPrincipalId

public groupPrincipalId: pulumi.Output<string>;

The groupPrincipal ID to assign cluster role template binding (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for cluster role template binding (map)

property name

public name: pulumi.Output<string>;

The name of the cluster role template binding (string)

property roleTemplateId

public roleTemplateId: pulumi.Output<string>;

The role template id from create cluster role template binding (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string | undefined>;

The user ID to assign cluster role template binding (string)

property userPrincipalId

public userPrincipalId: pulumi.Output<string>;

The userPrincipal ID to assign cluster role template binding (string)

Resource ClusterSync

class ClusterSync extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/cluster_sync.html.markdown.

constructor

new ClusterSync(name: string, args: ClusterSyncArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterSync resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterSyncState, opts?: pulumi.CustomResourceOptions): ClusterSync

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterSync

Returns true if the given object is an instance of ClusterSync. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property clusterId

public clusterId: pulumi.Output<string>;

The cluster ID that is syncing (string)

property defaultProjectId

public defaultProjectId: pulumi.Output<string>;

(Computed) Default project ID for the cluster sync (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kubeConfig

public kubeConfig: pulumi.Output<string>;

(Computed) Kube Config generated for the cluster sync (string)

property nodePoolIds

public nodePoolIds: pulumi.Output<string[] | undefined>;

The node pool IDs used by the cluster id (list)

property synced

public synced: pulumi.Output<boolean | undefined>;

property systemProjectId

public systemProjectId: pulumi.Output<string>;

(Computed) System project ID for the cluster sync (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterTemplate

class ClusterTemplate extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/cluster_template.html.markdown.

constructor

new ClusterTemplate(name: string, args?: ClusterTemplateArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterTemplate resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterTemplateState, opts?: pulumi.CustomResourceOptions): ClusterTemplate

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterTemplate

Returns true if the given object is an instance of ClusterTemplate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for the cluster template revision (map)

property defaultRevisionId

public defaultRevisionId: pulumi.Output<string>;

(Computed) Default cluster template revision ID (string)

property description

public description: pulumi.Output<string | undefined>;

Cluster template description

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for the cluster template revision (map)

property members

public members: pulumi.Output<ClusterTemplateMember[] | undefined>;

Cluster template members (list)

property name

public name: pulumi.Output<string>;

The cluster template revision name (string)

property templateRevisions

public templateRevisions: pulumi.Output<ClusterTemplateTemplateRevision[]>;

Cluster template revisions (list)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EtcdBackup

class EtcdBackup extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/etcd_backup.html.markdown.

constructor

new EtcdBackup(name: string, args: EtcdBackupArgs, opts?: pulumi.CustomResourceOptions)

Create a EtcdBackup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EtcdBackupState, opts?: pulumi.CustomResourceOptions): EtcdBackup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EtcdBackup

Returns true if the given object is an instance of EtcdBackup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for Etcd Backup object (map)

property backupConfig

public backupConfig: pulumi.Output<EtcdBackupBackupConfig>;

Backup config for etcd backup (list maxitems:1)

property clusterId

public clusterId: pulumi.Output<string>;

Cluster ID to config Etcd Backup (string)

property filename

public filename: pulumi.Output<string>;

Filename of the Etcd Backup (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for Etcd Backup object (map)

property manual

public manual: pulumi.Output<boolean | undefined>;

Manual execution of the Etcd Backup. Default false (bool)

property name

public name: pulumi.Output<string>;

The name of the Etcd Backup (string)

property namespaceId

public namespaceId: pulumi.Output<string>;

Description for the Etcd Backup (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource GlobalRoleBinding

class GlobalRoleBinding extends CustomResource

Provides a Rancher v2 Global Role Binding resource. This can be used to create Global Role Bindings for Rancher v2 environments and retrieve their information.

Example Usage

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

// Create a new rancher2 Global Role Binding
const foo = new rancher2.GlobalRoleBinding("foo", {
    globalRoleId: "<global_role_id>",
    userId: "<user_id>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/global_role_binding.html.markdown.

constructor

new GlobalRoleBinding(name: string, args: GlobalRoleBindingArgs, opts?: pulumi.CustomResourceOptions)

Create a GlobalRoleBinding resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GlobalRoleBindingState, opts?: pulumi.CustomResourceOptions): GlobalRoleBinding

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is GlobalRoleBinding

Returns true if the given object is an instance of GlobalRoleBinding. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for global role binding (map)

property globalRoleId

public globalRoleId: pulumi.Output<string>;

The role id from create global role binding (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for global role binding (map)

property name

public name: pulumi.Output<string>;

The name of the global role binding (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string>;

The user ID to assign global role binding (string)

Resource MultiClusterApp

class MultiClusterApp extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/multi_cluster_app.html.markdown.

constructor

new MultiClusterApp(name: string, args: MultiClusterAppArgs, opts?: pulumi.CustomResourceOptions)

Create a MultiClusterApp resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MultiClusterAppState, opts?: pulumi.CustomResourceOptions): MultiClusterApp

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is MultiClusterApp

Returns true if the given object is an instance of MultiClusterApp. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for multi cluster app object (map)

property answers

public answers: pulumi.Output<MultiClusterAppAnswer[]>;

The multi cluster app answers (list)

property catalogName

public catalogName: pulumi.Output<string>;

The multi cluster app catalog name (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for multi cluster app object (map)

property members

public members: pulumi.Output<MultiClusterAppMember[] | undefined>;

The multi cluster app answers (list)

property name

public name: pulumi.Output<string>;

The multi cluster app name (string)

property revisionHistoryLimit

public revisionHistoryLimit: pulumi.Output<number | undefined>;

The multi cluster app revision history limit. Default 10 (int)

property revisionId

public revisionId: pulumi.Output<string>;

Current revision id for the multi cluster app (string)

property roles

public roles: pulumi.Output<string[]>;

The multi cluster app roles (list)

property targets

public targets: pulumi.Output<MultiClusterAppTarget[]>;

The multi cluster app target projects (list)

property templateName

public templateName: pulumi.Output<string>;

The multi cluster app template name (string)

property templateVersion

public templateVersion: pulumi.Output<string>;

The multi cluster app template version. Default: latest (string)

property templateVersionId

public templateVersionId: pulumi.Output<string>;

(Computed) The multi cluster app template version ID (string)

property upgradeStrategy

public upgradeStrategy: pulumi.Output<MultiClusterAppUpgradeStrategy>;

The multi cluster app upgrade strategy (list MaxItems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property wait

public wait: pulumi.Output<boolean | undefined>;

Wait until the multi cluster app is active. Default true (bool)

Resource Namespace

class Namespace extends CustomResource

Provides a Rancher v2 Namespace resource. This can be used to create namespaces for Rancher v2 environments and retrieve their information.

Example Usage

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

// Create a new rancher2 Namespace
const foo = new rancher2.Namespace("foo", {
    containerResourceLimit: {
        limitsCpu: "20m",
        limitsMemory: "20Mi",
        requestsCpu: "1m",
        requestsMemory: "1Mi",
    },
    description: "foo namespace",
    projectId: "<PROJECT_ID>",
    resourceQuota: {
        limit: {
            limitsCpu: "100m",
            limitsMemory: "100Mi",
            requestsStorage: "1Gi",
        },
    },
});
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Cluster
const fooCustom = new rancher2.Cluster("foo-custom", {
    description: "Foo rancher2 custom cluster",
    rkeConfig: {
        network: {
            plugin: "canal",
        },
    },
});
// Create a new rancher2 Namespace assigned to default cluster project
const foo = new rancher2.Namespace("foo", {
    containerResourceLimit: {
        limitsCpu: "20m",
        limitsMemory: "20Mi",
        requestsCpu: "1m",
        requestsMemory: "1Mi",
    },
    description: "foo namespace",
    projectId: foo_custom.defaultProjectId,
    resourceQuota: {
        limit: {
            limitsCpu: "100m",
            limitsMemory: "100Mi",
            requestsStorage: "1Gi",
        },
    },
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/namespace.html.markdown.

constructor

new Namespace(name: string, args: NamespaceArgs, opts?: pulumi.CustomResourceOptions)

Create a Namespace resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NamespaceState, opts?: pulumi.CustomResourceOptions): Namespace

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Namespace

Returns true if the given object is an instance of Namespace. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for Node Pool object (map)

property containerResourceLimit

public containerResourceLimit: pulumi.Output<NamespaceContainerResourceLimit | undefined>;

Default containers resource limits on namespace (List maxitem:1)

property description

public description: pulumi.Output<string | undefined>;

A namespace description (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for Node Pool object (map)

property name

public name: pulumi.Output<string>;

The name of the namespace (string)

property projectId

public projectId: pulumi.Output<string>;

The project id where assign namespace. It’s on the form project_id=<cluster_id>:<id>. Updating <id> part on same <cluster_id> namespace will be moved between projects (string)

property resourceQuota

public resourceQuota: pulumi.Output<NamespaceResourceQuota | undefined>;

Resource quota for namespace. Rancher v2.1.x or higher (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property waitForCluster

public waitForCluster: pulumi.Output<boolean | undefined>;

Wait for cluster becomes active. Default false (bool)

Resource NodeDriver

class NodeDriver extends CustomResource

Provides a Rancher v2 Node Driver resource. This can be used to create Node Driver for Rancher v2 RKE clusters and retrieve their information.

Example Usage

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

// Create a new rancher2 Node Driver
const foo = new rancher2.NodeDriver("foo", {
    active: true,
    builtin: false,
    checksum: "0x0",
    description: "Foo description",
    externalId: "fooExternal",
    uiUrl: "local://ui",
    url: "local://",
    whitelistDomains: ["*.foo.com"],
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/node_driver.html.markdown.

constructor

new NodeDriver(name: string, args: NodeDriverArgs, opts?: pulumi.CustomResourceOptions)

Create a NodeDriver resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NodeDriverState, opts?: pulumi.CustomResourceOptions): NodeDriver

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NodeDriver

Returns true if the given object is an instance of NodeDriver. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property active

public active: pulumi.Output<boolean>;

Specify if the node driver state (bool)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the resource (map)

property builtin

public builtin: pulumi.Output<boolean>;

Specify wheter the node driver is an internal node driver or not (bool)

property checksum

public checksum: pulumi.Output<string | undefined>;

Verify that the downloaded driver matches the expected checksum (string)

property description

public description: pulumi.Output<string | undefined>;

Description of the node driver (string)

property externalId

public externalId: pulumi.Output<string | undefined>;

External ID (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the resource (map)

property name

public name: pulumi.Output<string>;

Name of the node driver (string)

property uiUrl

public uiUrl: pulumi.Output<string | undefined>;

The URL to load for customized Add Nodes screen for this driver (string)

property url

public url: pulumi.Output<string>;

The URL to download the machine driver binary for 64-bit Linux (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property whitelistDomains

public whitelistDomains: pulumi.Output<string[] | undefined>;

Domains to whitelist for the ui (list)

Resource NodePool

class NodePool extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/node_pool.html.markdown.

constructor

new NodePool(name: string, args: NodePoolArgs, opts?: pulumi.CustomResourceOptions)

Create a NodePool resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NodePoolState, opts?: pulumi.CustomResourceOptions): NodePool

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NodePool

Returns true if the given object is an instance of NodePool. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for Node Pool object (map)

property clusterId

public clusterId: pulumi.Output<string>;

The RKE cluster id to use Node Pool (string)

property controlPlane

public controlPlane: pulumi.Output<boolean | undefined>;

RKE control plane role for created nodes (bool)

property etcd

public etcd: pulumi.Output<boolean | undefined>;

RKE etcd role for created nodes (bool)

property hostnamePrefix

public hostnamePrefix: pulumi.Output<string>;

The prefix for created nodes of the Node Pool (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for Node Pool object (map)

property name

public name: pulumi.Output<string>;

The name of the Node Pool (string)

property nodeTemplateId

public nodeTemplateId: pulumi.Output<string>;

The Node Template ID to use for node creation (string)

property quantity

public quantity: pulumi.Output<number | undefined>;

The number of nodes to create on Node Pool. Default 1. Only values >= 1 allowed (int)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property worker

public worker: pulumi.Output<boolean | undefined>;

RKE role role for created nodes (bool)

Resource NodeTemplate

class NodeTemplate extends CustomResource

Provides a Rancher v2 Node Template resource. This can be used to create Node Template for Rancher v2 and retrieve their information.

amazonec2, azure, digitalocean, openstack and vsphere drivers are supported for node templates.

Note If you are upgrading to Rancher v2.3.3, please take a look to final section

Example Usage

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

// Create a new rancher2 Node Template up to Rancher 2.1.x
const foo = new rancher2.NodeTemplate("foo", {
    amazonec2Config: {
        accessKey: "AWS_ACCESS_KEY",
        ami: "<AMI_ID>",
        region: "<REGION>",
        secretKey: "<AWS_SECRET_KEY>",
        securityGroups: ["<AWS_SECURITY_GROUP>"],
        subnetId: "<SUBNET_ID>",
        vpcId: "<VPC_ID>",
        zone: "<ZONE>",
    },
    description: "foo test",
});
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Node Template from Rancher 2.2.x
const fooCloudCredential = new rancher2.CloudCredential("foo", {
    amazonec2CredentialConfig: {
        accessKey: "<AWS_ACCESS_KEY>",
        secretKey: "<AWS_SECRET_KEY>",
    },
    description: "foo test",
});
const fooNodeTemplate = new rancher2.NodeTemplate("foo", {
    amazonec2Config: {
        ami: "<AMI_ID>",
        region: "<REGION>",
        securityGroups: ["<AWS_SECURITY_GROUP>"],
        subnetId: "<SUBNET_ID>",
        vpcId: "<VPC_ID>",
        zone: "<ZONE>",
    },
    cloudCredentialId: fooCloudCredential.id,
    description: "foo test",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/node_template.html.markdown.

constructor

new NodeTemplate(name: string, args?: NodeTemplateArgs, opts?: pulumi.CustomResourceOptions)

Create a NodeTemplate resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NodeTemplateState, opts?: pulumi.CustomResourceOptions): NodeTemplate

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NodeTemplate

Returns true if the given object is an instance of NodeTemplate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property amazonec2Config

public amazonec2Config: pulumi.Output<NodeTemplateAmazonec2Config | undefined>;

AWS config for the Node Template (list maxitems:1)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for Node Template object (map)

property authCertificateAuthority

public authCertificateAuthority: pulumi.Output<string | undefined>;

Auth certificate authority for the Node Template (string)

property authKey

public authKey: pulumi.Output<string | undefined>;

Auth key for the Node Template (string)

property azureConfig

public azureConfig: pulumi.Output<NodeTemplateAzureConfig | undefined>;

Azure config for the Node Template (list maxitems:1)

property cloudCredentialId

public cloudCredentialId: pulumi.Output<string | undefined>;

Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

property description

public description: pulumi.Output<string | undefined>;

Description for the Node Template (string)

property digitaloceanConfig

public digitaloceanConfig: pulumi.Output<NodeTemplateDigitaloceanConfig | undefined>;

Digitalocean config for the Node Template (list maxitems:1)

property driver

public driver: pulumi.Output<string>;

(Computed) The driver of the node template (string)

property engineEnv

public engineEnv: pulumi.Output<{[key: string]: any} | undefined>;

Engine environment for the node template (string)

property engineInsecureRegistries

public engineInsecureRegistries: pulumi.Output<string[] | undefined>;

Insecure registry for the node template (list)

property engineInstallUrl

public engineInstallUrl: pulumi.Output<string | undefined>;

Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)

property engineLabel

public engineLabel: pulumi.Output<{[key: string]: any} | undefined>;

Engine label for the node template (string)

property engineOpt

public engineOpt: pulumi.Output<{[key: string]: any} | undefined>;

Engine options for the node template (map)

property engineRegistryMirrors

public engineRegistryMirrors: pulumi.Output<string[] | undefined>;

Engine registry mirror for the node template (list)

property engineStorageDriver

public engineStorageDriver: pulumi.Output<string | undefined>;

Engine storage driver for the node template (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for Node Template object (map)

property name

public name: pulumi.Output<string>;

The name of the Node Template (string)

property openstackConfig

public openstackConfig: pulumi.Output<NodeTemplateOpenstackConfig | undefined>;

Openstack config for the Node Template (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property useInternalIpAddress

public useInternalIpAddress: pulumi.Output<boolean | undefined>;

Engine storage driver for the node template (bool)

property vsphereConfig

public vsphereConfig: pulumi.Output<NodeTemplateVsphereConfig | undefined>;

vSphere config for the Node Template (list maxitems:1)

Resource Notifier

class Notifier extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/notifier.html.markdown.

constructor

new Notifier(name: string, args: NotifierArgs, opts?: pulumi.CustomResourceOptions)

Create a Notifier resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NotifierState, opts?: pulumi.CustomResourceOptions): Notifier

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Notifier

Returns true if the given object is an instance of Notifier. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for notifier object (map)

property clusterId

public clusterId: pulumi.Output<string>;

The cluster id where create notifier (string)

property description

public description: pulumi.Output<string | undefined>;

The notifier description (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for notifier object (map)

property name

public name: pulumi.Output<string>;

The name of the notifier (string)

property pagerdutyConfig

public pagerdutyConfig: pulumi.Output<NotifierPagerdutyConfig | undefined>;

Pagerduty config for notifier (list maxitems:1)

property slackConfig

public slackConfig: pulumi.Output<NotifierSlackConfig | undefined>;

Slack config for notifier (list maxitems:1)

property smtpConfig

public smtpConfig: pulumi.Output<NotifierSmtpConfig | undefined>;

SMTP config for notifier (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property webhookConfig

public webhookConfig: pulumi.Output<NotifierWebhookConfig | undefined>;

Webhook config for notifier (list maxitems:1)

property wechatConfig

public wechatConfig: pulumi.Output<NotifierWechatConfig | undefined>;

Wechat config for notifier (list maxitems:1)

Resource Project

class Project extends CustomResource

Provides a Rancher v2 Project resource. This can be used to create projects for Rancher v2 environments and retrieve their information.

Example Usage

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

// Create a new rancher2 Project
const foo = new rancher2.Project("foo", {
    clusterId: "<CLUSTER_ID>",
    containerResourceLimit: {
        limitsCpu: "20m",
        limitsMemory: "20Mi",
        requestsCpu: "1m",
        requestsMemory: "1Mi",
    },
    resourceQuota: {
        namespaceDefaultLimit: {
            limitsCpu: "2000m",
            limitsMemory: "500Mi",
            requestsStorage: "1Gi",
        },
        projectLimit: {
            limitsCpu: "2000m",
            limitsMemory: "2000Mi",
            requestsStorage: "2Gi",
        },
    },
});
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Project enabling and customizing monitoring
const foo = new rancher2.Project("foo", {
    clusterId: "<CLUSTER_ID>",
    containerResourceLimit: {
        limitsCpu: "20m",
        limitsMemory: "20Mi",
        requestsCpu: "1m",
        requestsMemory: "1Mi",
    },
    enableProjectMonitoring: true,
    projectMonitoringInput: {
        answers: {
            "exporter-kubelets.https": true,
            "exporter-node.enabled": true,
            "exporter-node.ports.metrics.port": 9796,
            "exporter-node.resources.limits.cpu": "200m",
            "exporter-node.resources.limits.memory": "200Mi",
            "grafana.persistence.enabled": false,
            "grafana.persistence.size": "10Gi",
            "grafana.persistence.storageClass": "default",
            "operator.resources.limits.memory": "500Mi",
            "prometheus.persistence.enabled": "false",
            "prometheus.persistence.size": "50Gi",
            "prometheus.persistence.storageClass": "default",
            "prometheus.persistent.useReleaseName": "true",
            "prometheus.resources.core.limits.cpu": "1000m",
            "prometheus.resources.core.limits.memory": "1500Mi",
            "prometheus.resources.core.requests.cpu": "750m",
            "prometheus.resources.core.requests.memory": "750Mi",
            "prometheus.retention": "12h",
        },
    },
    resourceQuota: {
        namespaceDefaultLimit: {
            limitsCpu: "2000m",
            limitsMemory: "500Mi",
            requestsStorage: "1Gi",
        },
        projectLimit: {
            limitsCpu: "2000m",
            limitsMemory: "2000Mi",
            requestsStorage: "2Gi",
        },
    },
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/project.html.markdown.

constructor

new Project(name: string, args: ProjectArgs, opts?: pulumi.CustomResourceOptions)

Create a Project resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectState, opts?: pulumi.CustomResourceOptions): Project

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Project

Returns true if the given object is an instance of Project. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for Node Pool object (map)

property clusterId

public clusterId: pulumi.Output<string>;

The cluster id where create project (string)

property containerResourceLimit

public containerResourceLimit: pulumi.Output<ProjectContainerResourceLimit | undefined>;

Default containers resource limits on project (List maxitem:1)

property description

public description: pulumi.Output<string | undefined>;

A project description (string)

property enableProjectMonitoring

public enableProjectMonitoring: pulumi.Output<boolean | undefined>;

Enable built-in project monitoring. Default false (bool)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for Node Pool object (map)

property name

public name: pulumi.Output<string>;

The name of the project (string)

property podSecurityPolicyTemplateId

public podSecurityPolicyTemplateId: pulumi.Output<string | undefined>;

Default Pod Security Policy ID for the project (string)

property projectMonitoringInput

public projectMonitoringInput: pulumi.Output<ProjectProjectMonitoringInput>;

Project monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)

property resourceQuota

public resourceQuota: pulumi.Output<ProjectResourceQuota | undefined>;

Resource quota for project. Rancher v2.1.x or higher (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property waitForCluster

public waitForCluster: pulumi.Output<boolean | undefined>;

Wait for cluster becomes active. Default false (bool)

Resource ProjectAlertGroup

class ProjectAlertGroup extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/project_alert_group.html.markdown.

constructor

new ProjectAlertGroup(name: string, args: ProjectAlertGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ProjectAlertGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectAlertGroupState, opts?: pulumi.CustomResourceOptions): ProjectAlertGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectAlertGroup

Returns true if the given object is an instance of ProjectAlertGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

The project alert group annotations (map)

property description

public description: pulumi.Output<string | undefined>;

The project alert group description (string)

property groupIntervalSeconds

public groupIntervalSeconds: pulumi.Output<number | undefined>;

The project alert group interval seconds. Default: 180 (int)

property groupWaitSeconds

public groupWaitSeconds: pulumi.Output<number | undefined>;

The project alert group wait seconds. Default: 180 (int)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

The project alert group labels (map)

property name

public name: pulumi.Output<string>;

The project alert group name (string)

property projectId

public projectId: pulumi.Output<string>;

The project id where create project alert group (string)

property recipients

public recipients: pulumi.Output<ProjectAlertGroupRecipient[] | undefined>;

The project alert group recipients (list)

property repeatIntervalSeconds

public repeatIntervalSeconds: pulumi.Output<number | undefined>;

The project alert group wait seconds. Default: 3600 (int)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ProjectAlertRule

class ProjectAlertRule extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/project_alert_rule.html.markdown.

constructor

new ProjectAlertRule(name: string, args: ProjectAlertRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a ProjectAlertRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectAlertRuleState, opts?: pulumi.CustomResourceOptions): ProjectAlertRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectAlertRule

Returns true if the given object is an instance of ProjectAlertRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

The project alert rule annotations (map)

property groupId

public groupId: pulumi.Output<string>;

The project alert rule alert group ID (string)

property groupIntervalSeconds

public groupIntervalSeconds: pulumi.Output<number | undefined>;

The project alert rule group interval seconds. Default: 180 (int)

property groupWaitSeconds

public groupWaitSeconds: pulumi.Output<number | undefined>;

The project alert rule group wait seconds. Default: 180 (int)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property inherited

public inherited: pulumi.Output<boolean | undefined>;

The project alert rule inherited. Default: true (bool)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

The project alert rule labels (map)

property metricRule

public metricRule: pulumi.Output<ProjectAlertRuleMetricRule | undefined>;

The project alert rule metric rule. ConflictsWith: "podRule", "workloadRule"` (list Maxitems:1)

property name

public name: pulumi.Output<string>;

The project alert rule name (string)

property podRule

public podRule: pulumi.Output<ProjectAlertRulePodRule | undefined>;

The project alert rule pod rule. ConflictsWith: "metricRule", "workloadRule"` (list Maxitems:1)

property projectId

public projectId: pulumi.Output<string>;

The project id where create project alert rule (string)

property repeatIntervalSeconds

public repeatIntervalSeconds: pulumi.Output<number | undefined>;

The project alert rule wait seconds. Default: 3600 (int)

property severity

public severity: pulumi.Output<string | undefined>;

The project alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property workloadRule

public workloadRule: pulumi.Output<ProjectAlertRuleWorkloadRule | undefined>;

The project alert rule workload rule. ConflictsWith: "metricRule", "podRule"` (list Maxitems:1)

Resource ProjectLogging

class ProjectLogging extends CustomResource

Provides a Rancher v2 Project Logging resource. This can be used to create Project Logging for Rancher v2 environments and retrieve their information.

Example Usage

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

// Create a new rancher2 Project Logging
const foo = new rancher2.ProjectLogging("foo", {
    kind: "syslog",
    projectId: "<project_id>",
    syslogConfig: {
        endpoint: "<syslog_endpoint>",
        protocol: "udp",
        severity: "notice",
        sslVerify: false,
    },
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/project_logging.html.markdown.

constructor

new ProjectLogging(name: string, args: ProjectLoggingArgs, opts?: pulumi.CustomResourceOptions)

Create a ProjectLogging resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectLoggingState, opts?: pulumi.CustomResourceOptions): ProjectLogging

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectLogging

Returns true if the given object is an instance of ProjectLogging. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for Project Logging object (map)

property elasticsearchConfig

public elasticsearchConfig: pulumi.Output<ProjectLoggingElasticsearchConfig | undefined>;

The elasticsearch config for Project Logging. For kind = elasticsearch. Conflicts with fluentdConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property fluentdConfig

public fluentdConfig: pulumi.Output<ProjectLoggingFluentdConfig | undefined>;

The fluentd config for Project Logging. For kind = fluentd. Conflicts with elasticsearchConfig, kafkaConfig, splunkConfig and syslogConfig (list maxitems:1)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kafkaConfig

public kafkaConfig: pulumi.Output<ProjectLoggingKafkaConfig | undefined>;

The kafka config for Project Logging. For kind = kafka. Conflicts with elasticsearchConfig, fluentdConfig, splunkConfig and syslogConfig (list maxitems:1)

property kind

public kind: pulumi.Output<string>;

The kind of the Project Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for Project Logging object (map)

property name

public name: pulumi.Output<string>;

The name of the Project Logging config (string)

property namespaceId

public namespaceId: pulumi.Output<string | undefined>;

The namespace id from Project logging (string)

property outputFlushInterval

public outputFlushInterval: pulumi.Output<number | undefined>;

How often buffered logs would be flushed. Default: 3 seconds (int)

property outputTags

public outputTags: pulumi.Output<{[key: string]: any}>;

The output tags for Project Logging (map)

property projectId

public projectId: pulumi.Output<string>;

The project id to configure logging (string)

property splunkConfig

public splunkConfig: pulumi.Output<ProjectLoggingSplunkConfig | undefined>;

The splunk config for Project Logging. For kind = splunk. Conflicts with elasticsearchConfig, fluentdConfig, kafkaConfig, and syslogConfig (list maxitems:1)

property syslogConfig

public syslogConfig: pulumi.Output<ProjectLoggingSyslogConfig | undefined>;

The syslog config for Project Logging. For kind = syslog. Conflicts with elasticsearchConfig, fluentdConfig, kafkaConfig, and splunkConfig (list maxitems:1)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ProjectRoleTemplateBinding

class ProjectRoleTemplateBinding extends CustomResource

Provides a Rancher v2 Project Role Template Binding resource. This can be used to create Project Role Template Bindings for Rancher v2 environments and retrieve their information.

Example Usage

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

// Create a new rancher2 Project Role Template Binding
const foo = new rancher2.ProjectRoleTemplateBinding("foo", {
    projectId: "<project_id>",
    roleTemplateId: "<role_template_id>",
    userId: "<user_id>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/project_role_template_binding.html.markdown.

constructor

new ProjectRoleTemplateBinding(name: string, args: ProjectRoleTemplateBindingArgs, opts?: pulumi.CustomResourceOptions)

Create a ProjectRoleTemplateBinding resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectRoleTemplateBindingState, opts?: pulumi.CustomResourceOptions): ProjectRoleTemplateBinding

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectRoleTemplateBinding

Returns true if the given object is an instance of ProjectRoleTemplateBinding. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the resource (map)

property groupId

public groupId: pulumi.Output<string | undefined>;

The group ID to assign project role template binding (string)

property groupPrincipalId

public groupPrincipalId: pulumi.Output<string>;

The groupPrincipal ID to assign project role template binding (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the resource (map)

property name

public name: pulumi.Output<string>;

The name of the project role template binding (string)

property projectId

public projectId: pulumi.Output<string>;

The project id where bind project role template (string)

property roleTemplateId

public roleTemplateId: pulumi.Output<string>;

The role template id from create project role template binding (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string | undefined>;

The user ID to assign project role template binding (string)

property userPrincipalId

public userPrincipalId: pulumi.Output<string>;

The userPrincipal ID to assign project role template binding (string)

Resource Provider

class Provider extends ProviderResource

The provider type for the rancher2 package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/index.html.markdown.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Registry

class Registry extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/registry.html.markdown.

constructor

new Registry(name: string, args: RegistryArgs, opts?: pulumi.CustomResourceOptions)

Create a Registry resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RegistryState, opts?: pulumi.CustomResourceOptions): Registry

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Registry

Returns true if the given object is an instance of Registry. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for Registry object (map)

property description

public description: pulumi.Output<string | undefined>;

A registry description (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for Registry object (map)

property name

public name: pulumi.Output<string>;

The name of the registry (string)

property namespaceId

public namespaceId: pulumi.Output<string | undefined>;

The namespace id where to assign the namespaced registry (string)

property projectId

public projectId: pulumi.Output<string>;

The project id where to assign the registry (string)

property registries

public registries: pulumi.Output<RegistryRegistry[]>;

Registries data for registry (list)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RoleTempalte

class RoleTempalte extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/role_template.html.markdown.

constructor

new RoleTempalte(name: string, args?: RoleTempalteArgs, opts?: pulumi.CustomResourceOptions)

Create a RoleTempalte resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RoleTempalteState, opts?: pulumi.CustomResourceOptions): RoleTempalte

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RoleTempalte

Returns true if the given object is an instance of RoleTempalte. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property administrative

public administrative: pulumi.Output<boolean | undefined>;

Administrative role template. Default false (bool)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for role template object (map)

property builtin

public builtin: pulumi.Output<boolean>;

(Computed) Builtin role template (string)

property context

public context: pulumi.Output<string | undefined>;

Role template context. cluster and project values are supported. Default: cluster (string)

property defaultRole

public defaultRole: pulumi.Output<boolean | undefined>;

Default role template for new created cluster or project. Default false (bool)

property description

public description: pulumi.Output<string>;

Role template description (string)

property external

public external: pulumi.Output<boolean | undefined>;

External role template. Default false (bool)

property hidden

public hidden: pulumi.Output<boolean | undefined>;

Hidden role template. Default false (bool)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for role template object (map)

property locked

public locked: pulumi.Output<boolean | undefined>;

Locked role template. Default false (bool)

property name

public name: pulumi.Output<string>;

Role template name (string)

property roleTemplateIds

public roleTemplateIds: pulumi.Output<string[]>;

Inherit role template IDs (list)

property rules

public rules: pulumi.Output<RoleTempalteRule[]>;

Role template policy rules (list)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Secret

class Secret extends CustomResource

Provides a Rancher v2 Secret resource. This can be used to create secrets for Rancher v2 environments and retrieve their information.

Depending of the availability, there are 2 types of Rancher v2 secrets: - Project secret: Available to all namespaces in the projectId - Namespaced secret: Available to just namespaceId in the projectId

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/secret.html.markdown.

constructor

new Secret(name: string, args: SecretArgs, opts?: pulumi.CustomResourceOptions)

Create a Secret resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SecretState, opts?: pulumi.CustomResourceOptions): Secret

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Secret

Returns true if the given object is an instance of Secret. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for secret object (map)

property data

public data: pulumi.Output<{[key: string]: any}>;

Secret key/value data. Base64 encoding required for values (map)

property description

public description: pulumi.Output<string | undefined>;

A secret description (string)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for secret object (map)

property name

public name: pulumi.Output<string>;

The name of the secret (string)

property namespaceId

public namespaceId: pulumi.Output<string | undefined>;

The namespace id where to assign the namespaced secret (string)

property projectId

public projectId: pulumi.Output<string>;

The project id where to assign the secret (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Setting

class Setting extends CustomResource

Provides a Rancher v2 Setting resource. This can be used to create settings for Rancher v2 environments and retrieve their information.

On create, if setting already exists, provider will import it and update its value.

On destroy, if setting is a system setting like server-url, provider’ll not delete it from Rancher, it’ll just update setting value to default and remove it from tfstate.

Example Usage

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

// Create a new rancher2 Setting
const foo = new rancher2.Setting("foo", {
    value: "<VALUE>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/setting.html.markdown.

constructor

new Setting(name: string, args: SettingArgs, opts?: pulumi.CustomResourceOptions)

Create a Setting resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SettingState, opts?: pulumi.CustomResourceOptions): Setting

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Setting

Returns true if the given object is an instance of Setting. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for setting object (map)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for setting object (map)

property name

public name: pulumi.Output<string>;

The name of the setting (string)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

The value of the setting (string)

Resource Token

class Token extends CustomResource

Provides a Rancher v2 Token resource. This can be used to create Tokens for Rancher v2 provider user and retrieve their information.

There are 2 kind of tokens: - no scoped: valid for global system. - scoped: valid for just a specific cluster (clusterId should be provided).

Tokens can’t be updated once created. Any diff in token data will recreate the token. If any token expire, Rancher2 provider will generate a diff to regenerate it.

Example Usage

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

// Create a new rancher2 Token scoped
const foo = new rancher2.Token("foo", {
    clusterId: "<cluster-id>",
    description: "foo token",
    ttl: 1200,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/token.html.markdown.

constructor

new Token(name: string, args?: TokenArgs, opts?: pulumi.CustomResourceOptions)

Create a Token resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TokenState, opts?: pulumi.CustomResourceOptions): Token

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Token

Returns true if the given object is an instance of Token. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessKey

public accessKey: pulumi.Output<string>;

(Computed) Token access key part (string)

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations of the token (map)

property clusterId

public clusterId: pulumi.Output<string | undefined>;

Cluster ID for scoped token (string)

property description

public description: pulumi.Output<string | undefined>;

Token description (string)

property enabled

public enabled: pulumi.Output<boolean>;

(Computed) Token is enabled (bool)

property expired

public expired: pulumi.Output<boolean>;

(Computed) Token is expired (bool)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels of the token (map)

property name

public name: pulumi.Output<string>;

(Computed) Token name (string)

property renew

public renew: pulumi.Output<boolean | undefined>;

Renew expired or disabled token

property secretKey

public secretKey: pulumi.Output<string>;

(Computed/Sensitive) Token secret key part (string)

property token

public token: pulumi.Output<string>;

(Computed/Sensitive) Token value (string)

property ttl

public ttl: pulumi.Output<number | undefined>;

Token time to live in seconds. Default 0 (int)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string>;

(Computed) Token user ID (string)

Resource User

class User extends CustomResource

Provides a Rancher v2 User resource. This can be used to create Users for Rancher v2 environments and retrieve their information.

When a Rancher User is created, it doesn’t have a global role binding. At least, user-base global role binding in needed in order to enable user login.

Example Usage

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

// Create a new rancher2 User
const fooUser = new rancher2.User("foo", {
    enabled: true,
    password: "changeme",
    username: "foo",
});
// Create a new rancher2 globalRoleBinding for User
const fooGlobalRoleBinding = new rancher2.GlobalRoleBinding("foo", {
    globalRoleId: "user-base",
    userId: fooUser.id,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/r/user.html.markdown.

constructor

new User(name: string, args: UserArgs, opts?: pulumi.CustomResourceOptions)

Create a User resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserState, opts?: pulumi.CustomResourceOptions): User

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is User

Returns true if the given object is an instance of User. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property annotations

public annotations: pulumi.Output<{[key: string]: any}>;

Annotations for global role binding (map)

property enabled

public enabled: pulumi.Output<boolean | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: any}>;

Labels for global role binding (map)

property name

public name: pulumi.Output<string>;

The user full name (string)

property password

public password: pulumi.Output<string>;

The user password (string)

property principalIds

public principalIds: pulumi.Output<string[]>;

(Computed) The user principal IDs (list)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string>;

The user username (string)

Data Sources

Data Source getApp

getApp(args: GetAppArgs, opts?: pulumi.InvokeOptions): Promise<GetAppResult> & GetAppResult

Use this data source to retrieve information about a Rancher v2 app.

Example Usage

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

const rancher2App = rancher2.getApp({
    name: "foo",
    projectId: "<project_id>",
    targetNamespace: "<namespace_name>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/app.html.markdown.

Data Source getCatalog

getCatalog(args: GetCatalogArgs, opts?: pulumi.InvokeOptions): Promise<GetCatalogResult> & GetCatalogResult

Use this data source to retrieve information about a Rancher v2 catalog.

Example Usage

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

const library = rancher2.getCatalog({
    name: "catalog",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/catalog.html.markdown.

Data Source getCertificate

getCertificate(args: GetCertificateArgs, opts?: pulumi.InvokeOptions): Promise<GetCertificateResult> & GetCertificateResult

Use this data source to retrieve information about a Rancher v2 certificate.

Depending of the availability, there are 2 types of Rancher v2 certificates: - Project certificate: Available to all namespaces in the projectId - Namespaced certificate: Available to just namespaceId in the projectId

Example Usage

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

// Retrieve a rancher2 Project Certificate
const foo = rancher2.getCertificate({
    name: "<name>",
    projectId: "<project_id>",
});
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Retrieve a rancher2 Namespaced Certificate
const foo = rancher2.getCertificate({
    name: "<name>",
    namespaceId: "<namespace_id>",
    projectId: "<project_id>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/certificate.html.markdown.

Data Source getCloudCredential

getCloudCredential(args: GetCloudCredentialArgs, opts?: pulumi.InvokeOptions): Promise<GetCloudCredentialResult> & GetCloudCredentialResult

Use this data source to retrieve information about a Rancher v2 Cloud Credential.

Example Usage

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

const test = rancher2.getCloudCredential({
    name: "test",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/cloud_credential.html.markdown.

Data Source getCluster

getCluster(args: GetClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterResult> & GetClusterResult

Use this data source to retrieve information about a Rancher v2 cluster.

Example Usage

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

const fooCustom = rancher2.getCluster({
    name: "foo-custom",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/cluster.html.markdown.

Data Source getClusterAlertGroup

getClusterAlertGroup(args: GetClusterAlertGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterAlertGroupResult> & GetClusterAlertGroupResult

Use this data source to retrieve information about a Rancher v2 cluster alert group.

Example Usage

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

const foo = rancher2.getClusterAlertGroup({
    clusterId: "<cluster_id>",
    name: "<cluster_alert_group_name>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/cluster_alert_group.html.markdown.

Data Source getClusterAlterRule

getClusterAlterRule(args: GetClusterAlterRuleArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterAlterRuleResult> & GetClusterAlterRuleResult

Use this data source to retrieve information about a Rancher v2 cluster alert rule.

Example Usage

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

const foo = rancher2.getClusterAlterRule({
    clusterId: "<cluster_id>",
    name: "<cluster_alert_rule_name>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/cluster_alert_rule.html.markdown.

Data Source getClusterDriver

getClusterDriver(args: GetClusterDriverArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterDriverResult> & GetClusterDriverResult

Use this data source to retrieve information about a Rancher v2 Cluster Driver resource.

Example Usage

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

const foo = rancher2.getClusterDriver({
    name: "foo",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/cluster_driver.html.markdown.

Data Source getClusterLogging

getClusterLogging(args: GetClusterLoggingArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterLoggingResult> & GetClusterLoggingResult

Use this data source to retrieve information about a Rancher v2 Cluster Logging.

Example Usage

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

const foo = rancher2.getClusterLogging({
    clusterId: "<cluster_id>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/cluster_logging.html.markdown.

Data Source getClusterRoleTemplateBinding

getClusterRoleTemplateBinding(args: GetClusterRoleTemplateBindingArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterRoleTemplateBindingResult> & GetClusterRoleTemplateBindingResult

Use this data source to retrieve information about a Rancher v2 cluster role template binding.

Example Usage

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

const foo = rancher2.getClusterRoleTemplateBinding({
    clusterId: "fooId",
    name: "foo",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/cluster_role_template_binding.html.markdown.

Data Source getClusterTemplate

getClusterTemplate(args: GetClusterTemplateArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterTemplateResult> & GetClusterTemplateResult

Use this data source to retrieve information about a Rancher v2 cluster template.

Cluster Templates are available from Rancher v2.3.x and above.

Example Usage

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

const foo = rancher2.getClusterTemplate({
    name: "foo",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/cluster_template.html.markdown.

Data Source getEtcdBackup

getEtcdBackup(args: GetEtcdBackupArgs, opts?: pulumi.InvokeOptions): Promise<GetEtcdBackupResult> & GetEtcdBackupResult

Use this data source to retrieve information about a Rancher v2 etcd backup.

Example Usage

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

const foo = rancher2.getEtcdBackup({
    clusterId: "<CLUSTER_ID>",
    name: "foo",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/etcd_backup.html.markdown.

Data Source getGlobalRoleBinding

getGlobalRoleBinding(args: GetGlobalRoleBindingArgs, opts?: pulumi.InvokeOptions): Promise<GetGlobalRoleBindingResult> & GetGlobalRoleBindingResult

Use this data source to retrieve information about a Rancher v2 global role binding.

Example Usage

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

const foo = rancher2.getGlobalRoleBinding({
    globalRoleId: "fooId",
    name: "foo",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/global_role_binding.html.markdown.

Data Source getMultiClusterApp

getMultiClusterApp(args: GetMultiClusterAppArgs, opts?: pulumi.InvokeOptions): Promise<GetMultiClusterAppResult> & GetMultiClusterAppResult

Use this data source to retrieve information about a Rancher v2 multi cluster app.

Example Usage

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

const foo = rancher2.getMultiClusterApp({
    name: "foo",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/multi_cluster_app.html.markdown.

Data Source getNamespace

getNamespace(args: GetNamespaceArgs, opts?: pulumi.InvokeOptions): Promise<GetNamespaceResult> & GetNamespaceResult

Use this data source to retrieve information about a Rancher v2 namespace.

Example Usage

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

const foo = rancher2_cluster_foo_custom.defaultProjectId.apply(defaultProjectId => rancher2.getNamespace({
    name: "foo",
    projectId: defaultProjectId,
}));

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/namespace.html.markdown.

Data Source getNodeDriver

getNodeDriver(args: GetNodeDriverArgs, opts?: pulumi.InvokeOptions): Promise<GetNodeDriverResult> & GetNodeDriverResult

Use this data source to retrieve information about a Rancher v2 Node Driver resource.

Example Usage

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

const foo = rancher2.getNodeDriver({
    name: "foo",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/node_driver.html.markdown.

Data Source getNodePool

getNodePool(args: GetNodePoolArgs, opts?: pulumi.InvokeOptions): Promise<GetNodePoolResult> & GetNodePoolResult

Use this data source to retrieve information about a Rancher v2 Node Pool resource.

Example Usage

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

const foo = rancher2_cluster_foo_custom.id.apply(id => rancher2.getNodePool({
    clusterId: id,
    name: "foo",
}));

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/node_pool.html.markdown.

Data Source getNodeTemplate

getNodeTemplate(args: GetNodeTemplateArgs, opts?: pulumi.InvokeOptions): Promise<GetNodeTemplateResult> & GetNodeTemplateResult

Use this data source to retrieve information about a Rancher v2 Node Template resource.

Example Usage

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

const foo = rancher2.getNodeTemplate({
    name: "foo",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/node_template.html.markdown.

Data Source getNotifier

getNotifier(args: GetNotifierArgs, opts?: pulumi.InvokeOptions): Promise<GetNotifierResult> & GetNotifierResult

Use this data source to retrieve information about a Rancher v2 notifier.

Example Usage

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

const foo = rancher2.getNotifier({
    clusterId: "<cluster_id>",
    name: "foo",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/notifier.html.markdown.

Data Source getProject

getProject(args: GetProjectArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectResult> & GetProjectResult

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/project.html.markdown.

Data Source getProjectAlertGroup

getProjectAlertGroup(args: GetProjectAlertGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectAlertGroupResult> & GetProjectAlertGroupResult

Use this data source to retrieve information about a Rancher v2 project alert group.

Example Usage

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

const foo = rancher2.getProjectAlertGroup({
    name: "<project_alert_group_name>",
    projectId: "<project_id>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/project_alert_group.html.markdown.

Data Source getProjectAlertRule

getProjectAlertRule(args: GetProjectAlertRuleArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectAlertRuleResult> & GetProjectAlertRuleResult

Use this data source to retrieve information about a Rancher v2 project alert rule.

Example Usage

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

const foo = rancher2.getProjectAlertRule({
    name: "<project_alert_rule_name>",
    projectId: "<project_id>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/project_alert_rule.html.markdown.

Data Source getProjectLogging

getProjectLogging(args: GetProjectLoggingArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectLoggingResult> & GetProjectLoggingResult

Use this data source to retrieve information about a Rancher v2 Project Logging.

Example Usage

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

const foo = rancher2.getProjectLogging({
    projectId: "<project_id>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/project_logging.html.markdown.

Data Source getProjectRoleTemplateBinding

getProjectRoleTemplateBinding(args: GetProjectRoleTemplateBindingArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectRoleTemplateBindingResult> & GetProjectRoleTemplateBindingResult

Use this data source to retrieve information about a Rancher v2 project role template binding.

Example Usage

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

const foo = rancher2.getProjectRoleTemplateBinding({
    name: "foo",
    projectId: "fooId",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/project_role_template_binding.html.markdown.

Data Source getRegistry

getRegistry(args: GetRegistryArgs, opts?: pulumi.InvokeOptions): Promise<GetRegistryResult> & GetRegistryResult

Use this data source to retrieve information about a Rancher v2 docker registry.

Depending of the availability, there are 2 types of Rancher v2 docker registries: - Project registry: Available to all namespaces in the projectId - Namespaced registry: Available to just namespaceId in the projectId

Example Usage

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

// Retrieve a rancher2 Project Registry
const foo = rancher2.getRegistry({
    name: "<name>",
    projectId: "<project_id>",
});
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Retrieve a rancher2 Namespaced Registry
const foo = rancher2.getRegistry({
    name: "<name>",
    namespaceId: "<namespace_id>",
    projectId: "<project_id>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/registry.html.markdown.

Data Source getRoleTempalte

getRoleTempalte(args: GetRoleTempalteArgs, opts?: pulumi.InvokeOptions): Promise<GetRoleTempalteResult> & GetRoleTempalteResult

Use this data source to retrieve information about a Rancher v2 role template resource.

Example Usage

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

const foo = rancher2.getRoleTempalte({
    name: "foo",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/role_template.html.markdown.

Data Source getSecret

getSecret(args: GetSecretArgs, opts?: pulumi.InvokeOptions): Promise<GetSecretResult> & GetSecretResult

Use this data source to retrieve information about a Rancher v2 secret.

Depending of the availability, there are 2 types of Rancher v2 secrets: - Project secret: Available to all namespaces in the projectId - Namespaced secret: Available to just namespaceId in the projectId

Example Usage

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

// Retrieve a rancher2 Project Secret
const foo = rancher2.getSecret({
    name: "<name>",
    projectId: "<project_id>",
});
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Retrieve a rancher2 Namespaced Secret
const foo = rancher2.getSecret({
    name: "<name>",
    namespaceId: "<namespace_id>",
    projectId: "<project_id>",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/secret.html.markdown.

Data Source getSetting

getSetting(args: GetSettingArgs, opts?: pulumi.InvokeOptions): Promise<GetSettingResult> & GetSettingResult

Use this data source to retrieve information about a Rancher v2 setting.

Example Usage

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

const serverImage = rancher2.getSetting({
    name: "server-image",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/setting.html.markdown.

Data Source getUser

getUser(args: GetUserArgs, opts?: pulumi.InvokeOptions): Promise<GetUserResult> & GetUserResult

Use this data source to retrieve information about a Rancher v2 user

Example Usage

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

const foo = rancher2.getUser({
    username: "foo",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-rancher2/blob/master/website/docs/d/user.html.markdown.

Others

interface ActiveDirectoryArgs

interface ActiveDirectoryArgs

The set of arguments for constructing a ActiveDirectory resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: activedirectory_user://<DN> activedirectory_group://<DN> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

certificate?: pulumi.Input<string>;

CA certificate for TLS if selfsigned (string)

property connectionTimeout

connectionTimeout?: pulumi.Input<number>;

ActiveDirectory connection timeout. Default 5000 (int)

property defaultLoginDomain

defaultLoginDomain?: pulumi.Input<string>;

ActiveDirectory defult lgoin domain (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

groupDnAttribute?: pulumi.Input<string>;

Group DN attribute. Default distinguishedName (string)

property groupMemberMappingAttribute

groupMemberMappingAttribute?: pulumi.Input<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

groupMemberUserAttribute?: pulumi.Input<string>;

Group member user attribute. Default distinguishedName (string)

property groupNameAttribute

groupNameAttribute?: pulumi.Input<string>;

Group name attribute. Default name (string)

property groupObjectClass

groupObjectClass?: pulumi.Input<string>;

Group object class. Default group (string)

property groupSearchAttribute

groupSearchAttribute?: pulumi.Input<string>;

Group search attribute. Default sAMAccountName (string)

property groupSearchBase

groupSearchBase?: pulumi.Input<string>;

Group search base (string)

property groupSearchFilter

groupSearchFilter?: pulumi.Input<string>;

Group search filter (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property nestedGroupMembershipEnabled

nestedGroupMembershipEnabled?: pulumi.Input<boolean>;

Nested group membership enable. Default false (bool)

property port

port?: pulumi.Input<number>;

ActiveDirectory port. Default 389 (int)

property servers

servers: pulumi.Input<pulumi.Input<string>[]>;

ActiveDirectory servers list (list)

property serviceAccountPassword

serviceAccountPassword: pulumi.Input<string>;

Service account password for access ActiveDirectory service (string)

property serviceAccountUsername

serviceAccountUsername: pulumi.Input<string>;

Service account DN for access ActiveDirectory service (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection (bool)

property userDisabledBitMask

userDisabledBitMask?: pulumi.Input<number>;

User disabled bit mask. Default 2 (int)

property userEnabledAttribute

userEnabledAttribute?: pulumi.Input<string>;

User enable attribute (string)

property userLoginAttribute

userLoginAttribute?: pulumi.Input<string>;

User login attribute. Default sAMAccountName (string)

property userNameAttribute

userNameAttribute?: pulumi.Input<string>;

User name attribute. Default name (string)

property userObjectClass

userObjectClass?: pulumi.Input<string>;

User object class. Default person (string)

property userSearchAttribute

userSearchAttribute?: pulumi.Input<string>;

User search attribute. Default sAMAccountName|sn|givenName (string)

property userSearchBase

userSearchBase: pulumi.Input<string>;

User search base DN (string)

property userSearchFilter

userSearchFilter?: pulumi.Input<string>;

User search filter (string)

interface ActiveDirectoryState

interface ActiveDirectoryState

Input properties used for looking up and filtering ActiveDirectory resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: activedirectory_user://<DN> activedirectory_group://<DN> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

certificate?: pulumi.Input<string>;

CA certificate for TLS if selfsigned (string)

property connectionTimeout

connectionTimeout?: pulumi.Input<number>;

ActiveDirectory connection timeout. Default 5000 (int)

property defaultLoginDomain

defaultLoginDomain?: pulumi.Input<string>;

ActiveDirectory defult lgoin domain (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

groupDnAttribute?: pulumi.Input<string>;

Group DN attribute. Default distinguishedName (string)

property groupMemberMappingAttribute

groupMemberMappingAttribute?: pulumi.Input<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

groupMemberUserAttribute?: pulumi.Input<string>;

Group member user attribute. Default distinguishedName (string)

property groupNameAttribute

groupNameAttribute?: pulumi.Input<string>;

Group name attribute. Default name (string)

property groupObjectClass

groupObjectClass?: pulumi.Input<string>;

Group object class. Default group (string)

property groupSearchAttribute

groupSearchAttribute?: pulumi.Input<string>;

Group search attribute. Default sAMAccountName (string)

property groupSearchBase

groupSearchBase?: pulumi.Input<string>;

Group search base (string)

property groupSearchFilter

groupSearchFilter?: pulumi.Input<string>;

Group search filter (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property nestedGroupMembershipEnabled

nestedGroupMembershipEnabled?: pulumi.Input<boolean>;

Nested group membership enable. Default false (bool)

property port

port?: pulumi.Input<number>;

ActiveDirectory port. Default 389 (int)

property servers

servers?: pulumi.Input<pulumi.Input<string>[]>;

ActiveDirectory servers list (list)

property serviceAccountPassword

serviceAccountPassword?: pulumi.Input<string>;

Service account password for access ActiveDirectory service (string)

property serviceAccountUsername

serviceAccountUsername?: pulumi.Input<string>;

Service account DN for access ActiveDirectory service (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection (bool)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property userDisabledBitMask

userDisabledBitMask?: pulumi.Input<number>;

User disabled bit mask. Default 2 (int)

property userEnabledAttribute

userEnabledAttribute?: pulumi.Input<string>;

User enable attribute (string)

property userLoginAttribute

userLoginAttribute?: pulumi.Input<string>;

User login attribute. Default sAMAccountName (string)

property userNameAttribute

userNameAttribute?: pulumi.Input<string>;

User name attribute. Default name (string)

property userObjectClass

userObjectClass?: pulumi.Input<string>;

User object class. Default person (string)

property userSearchAttribute

userSearchAttribute?: pulumi.Input<string>;

User search attribute. Default sAMAccountName|sn|givenName (string)

property userSearchBase

userSearchBase?: pulumi.Input<string>;

User search base DN (string)

property userSearchFilter

userSearchFilter?: pulumi.Input<string>;

User search filter (string)

interface AppArgs

interface AppArgs

The set of arguments for constructing a App resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for App object (map)

property answers

answers?: pulumi.Input<{[key: string]: any}>;

Answers for the app template. If modified, app will be upgraded (map)

property catalogName

catalogName: pulumi.Input<string>;

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs: * add cluster ID before name, c-XXXXX:<name> * add project ID before name, p-XXXXX:<name>

property description

description?: pulumi.Input<string>;

Description for the app (string)

property forceUpgrade

forceUpgrade?: pulumi.Input<boolean>;

Force app upgrade (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for App object (map)

property name

name?: pulumi.Input<string>;

The name of the app (string)

property projectId

projectId: pulumi.Input<string>;

The project id where the app will be installed (string)

property revisionId

revisionId?: pulumi.Input<string>;

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revisionId (string)

property targetNamespace

targetNamespace: pulumi.Input<string>;

The namespace name where the app will be installed (string)

property templateName

templateName: pulumi.Input<string>;

Template name of the app. If modified, app will be upgraded (string)

property templateVersion

templateVersion?: pulumi.Input<string>;

Template version of the app. If modified, app will be upgraded. Default: latest (string)

property valuesYaml

valuesYaml?: pulumi.Input<string>;

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

interface AppState

interface AppState

Input properties used for looking up and filtering App resources.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for App object (map)

property answers

answers?: pulumi.Input<{[key: string]: any}>;

Answers for the app template. If modified, app will be upgraded (map)

property catalogName

catalogName?: pulumi.Input<string>;

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs: * add cluster ID before name, c-XXXXX:<name> * add project ID before name, p-XXXXX:<name>

property description

description?: pulumi.Input<string>;

Description for the app (string)

property externalId

externalId?: pulumi.Input<string>;

(Computed) The url of the app template on a catalog (string)

property forceUpgrade

forceUpgrade?: pulumi.Input<boolean>;

Force app upgrade (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for App object (map)

property name

name?: pulumi.Input<string>;

The name of the app (string)

property projectId

projectId?: pulumi.Input<string>;

The project id where the app will be installed (string)

property revisionId

revisionId?: pulumi.Input<string>;

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revisionId (string)

property targetNamespace

targetNamespace?: pulumi.Input<string>;

The namespace name where the app will be installed (string)

property templateName

templateName?: pulumi.Input<string>;

Template name of the app. If modified, app will be upgraded (string)

property templateVersion

templateVersion?: pulumi.Input<string>;

Template version of the app. If modified, app will be upgraded. Default: latest (string)

property valuesYaml

valuesYaml?: pulumi.Input<string>;

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

interface AuthConfigAdfsArgs

interface AuthConfigAdfsArgs

The set of arguments for constructing a AuthConfigAdfs resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField: pulumi.Input<string>;

ADFS display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField: pulumi.Input<string>;

ADFS group field (string)

property idpMetadataContent

idpMetadataContent: pulumi.Input<string>;

ADFS IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property rancherApiHost

rancherApiHost: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert: pulumi.Input<string>;

ADFS SP cert (string)

property spKey

spKey: pulumi.Input<string>;

ADFS SP key (string)

property uidField

uidField: pulumi.Input<string>;

ADFS UID field (string)

property userNameField

userNameField: pulumi.Input<string>;

ADFS user name field (string)

interface AuthConfigAdfsState

interface AuthConfigAdfsState

Input properties used for looking up and filtering AuthConfigAdfs resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField?: pulumi.Input<string>;

ADFS display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField?: pulumi.Input<string>;

ADFS group field (string)

property idpMetadataContent

idpMetadataContent?: pulumi.Input<string>;

ADFS IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property rancherApiHost

rancherApiHost?: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert?: pulumi.Input<string>;

ADFS SP cert (string)

property spKey

spKey?: pulumi.Input<string>;

ADFS SP key (string)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property uidField

uidField?: pulumi.Input<string>;

ADFS UID field (string)

property userNameField

userNameField?: pulumi.Input<string>;

ADFS user name field (string)

interface AuthConfigAzureAdArgs

interface AuthConfigAzureAdArgs

The set of arguments for constructing a AuthConfigAzureAd resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: azuread_user://<USER_ID> azuread_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property applicationId

applicationId: pulumi.Input<string>;

AzureAD auth application ID (string)

property applicationSecret

applicationSecret: pulumi.Input<string>;

AzureAD auth application secret (string)

property authEndpoint

authEndpoint: pulumi.Input<string>;

AzureAD auth endpoint (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property endpoint

endpoint?: pulumi.Input<string>;

AzureAD endpoint. Default https://login.microsoftonline.com/ (string)

property graphEndpoint

graphEndpoint: pulumi.Input<string>;

AzureAD graph endpoint (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property rancherUrl

rancherUrl: pulumi.Input<string>;

Rancher URL (string). “/verify-auth-azure”

property tenantId

tenantId: pulumi.Input<string>;

AzureAD tenant ID (string)

property tokenEndpoint

tokenEndpoint: pulumi.Input<string>;

AzureAD token endpoint (string)

interface AuthConfigAzureAdState

interface AuthConfigAzureAdState

Input properties used for looking up and filtering AuthConfigAzureAd resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: azuread_user://<USER_ID> azuread_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property applicationId

applicationId?: pulumi.Input<string>;

AzureAD auth application ID (string)

property applicationSecret

applicationSecret?: pulumi.Input<string>;

AzureAD auth application secret (string)

property authEndpoint

authEndpoint?: pulumi.Input<string>;

AzureAD auth endpoint (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property endpoint

endpoint?: pulumi.Input<string>;

AzureAD endpoint. Default https://login.microsoftonline.com/ (string)

property graphEndpoint

graphEndpoint?: pulumi.Input<string>;

AzureAD graph endpoint (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property rancherUrl

rancherUrl?: pulumi.Input<string>;

Rancher URL (string). “/verify-auth-azure”

property tenantId

tenantId?: pulumi.Input<string>;

AzureAD tenant ID (string)

property tokenEndpoint

tokenEndpoint?: pulumi.Input<string>;

AzureAD token endpoint (string)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

interface AuthConfigFreeIpaArgs

interface AuthConfigFreeIpaArgs

The set of arguments for constructing a AuthConfigFreeIpa resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: freeipa_user://<DN> freeipa_group://<DN> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

certificate?: pulumi.Input<string>;

Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

property connectionTimeout

connectionTimeout?: pulumi.Input<number>;

FreeIpa connection timeout. Default 5000 (int)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

groupDnAttribute?: pulumi.Input<string>;

Group DN attribute. Default entryDN (string)

property groupMemberMappingAttribute

groupMemberMappingAttribute?: pulumi.Input<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

groupMemberUserAttribute?: pulumi.Input<string>;

Group member user attribute. Default entryDN (string)

property groupNameAttribute

groupNameAttribute?: pulumi.Input<string>;

Group name attribute. Default cn (string)

property groupObjectClass

groupObjectClass?: pulumi.Input<string>;

Group object class. Default groupOfNames (string)

property groupSearchAttribute

groupSearchAttribute?: pulumi.Input<string>;

Group search attribute. Default cn (string)

property groupSearchBase

groupSearchBase?: pulumi.Input<string>;

Group search base (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property nestedGroupMembershipEnabled

nestedGroupMembershipEnabled?: pulumi.Input<boolean>;

Nested group membership enable. Default false (bool)

property port

port?: pulumi.Input<number>;

FreeIpa port. Default 389 (int)

property servers

servers: pulumi.Input<pulumi.Input<string>[]>;

FreeIpa servers list (list)

property serviceAccountDistinguishedName

serviceAccountDistinguishedName: pulumi.Input<string>;

Service account DN for access FreeIpa service (string)

property serviceAccountPassword

serviceAccountPassword: pulumi.Input<string>;

Service account password for access FreeIpa service (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection (bool)

property userDisabledBitMask

userDisabledBitMask?: pulumi.Input<number>;

User disabled bit mask (int)

property userEnabledAttribute

userEnabledAttribute?: pulumi.Input<string>;

User enable attribute (string)

property userLoginAttribute

userLoginAttribute?: pulumi.Input<string>;

User login attribute. Default uid (string)

property userMemberAttribute

userMemberAttribute?: pulumi.Input<string>;

User member attribute. Default memberOf (string)

property userNameAttribute

userNameAttribute?: pulumi.Input<string>;

User name attribute. Default givenName (string)

property userObjectClass

userObjectClass?: pulumi.Input<string>;

User object class. Default inetorgperson (string)

property userSearchAttribute

userSearchAttribute?: pulumi.Input<string>;

User search attribute. Default uid|sn|givenName (string)

property userSearchBase

userSearchBase: pulumi.Input<string>;

User search base DN (string)

interface AuthConfigFreeIpaState

interface AuthConfigFreeIpaState

Input properties used for looking up and filtering AuthConfigFreeIpa resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: freeipa_user://<DN> freeipa_group://<DN> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

certificate?: pulumi.Input<string>;

Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

property connectionTimeout

connectionTimeout?: pulumi.Input<number>;

FreeIpa connection timeout. Default 5000 (int)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

groupDnAttribute?: pulumi.Input<string>;

Group DN attribute. Default entryDN (string)

property groupMemberMappingAttribute

groupMemberMappingAttribute?: pulumi.Input<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

groupMemberUserAttribute?: pulumi.Input<string>;

Group member user attribute. Default entryDN (string)

property groupNameAttribute

groupNameAttribute?: pulumi.Input<string>;

Group name attribute. Default cn (string)

property groupObjectClass

groupObjectClass?: pulumi.Input<string>;

Group object class. Default groupOfNames (string)

property groupSearchAttribute

groupSearchAttribute?: pulumi.Input<string>;

Group search attribute. Default cn (string)

property groupSearchBase

groupSearchBase?: pulumi.Input<string>;

Group search base (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property nestedGroupMembershipEnabled

nestedGroupMembershipEnabled?: pulumi.Input<boolean>;

Nested group membership enable. Default false (bool)

property port

port?: pulumi.Input<number>;

FreeIpa port. Default 389 (int)

property servers

servers?: pulumi.Input<pulumi.Input<string>[]>;

FreeIpa servers list (list)

property serviceAccountDistinguishedName

serviceAccountDistinguishedName?: pulumi.Input<string>;

Service account DN for access FreeIpa service (string)

property serviceAccountPassword

serviceAccountPassword?: pulumi.Input<string>;

Service account password for access FreeIpa service (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection (bool)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property userDisabledBitMask

userDisabledBitMask?: pulumi.Input<number>;

User disabled bit mask (int)

property userEnabledAttribute

userEnabledAttribute?: pulumi.Input<string>;

User enable attribute (string)

property userLoginAttribute

userLoginAttribute?: pulumi.Input<string>;

User login attribute. Default uid (string)

property userMemberAttribute

userMemberAttribute?: pulumi.Input<string>;

User member attribute. Default memberOf (string)

property userNameAttribute

userNameAttribute?: pulumi.Input<string>;

User name attribute. Default givenName (string)

property userObjectClass

userObjectClass?: pulumi.Input<string>;

User object class. Default inetorgperson (string)

property userSearchAttribute

userSearchAttribute?: pulumi.Input<string>;

User search attribute. Default uid|sn|givenName (string)

property userSearchBase

userSearchBase?: pulumi.Input<string>;

User search base DN (string)

interface AuthConfigGithubArgs

interface AuthConfigGithubArgs

The set of arguments for constructing a AuthConfigGithub resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: github_user://<USER_ID> github_team://<GROUP_ID> github_org://<ORG_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property clientId

clientId: pulumi.Input<string>;

Github auth Client ID (string)

property clientSecret

clientSecret: pulumi.Input<string>;

Github auth Client secret (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property hostname

hostname?: pulumi.Input<string>;

Github hostname to connect. Default github.com (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection. Default true (bool)

interface AuthConfigGithubState

interface AuthConfigGithubState

Input properties used for looking up and filtering AuthConfigGithub resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: github_user://<USER_ID> github_team://<GROUP_ID> github_org://<ORG_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property clientId

clientId?: pulumi.Input<string>;

Github auth Client ID (string)

property clientSecret

clientSecret?: pulumi.Input<string>;

Github auth Client secret (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property hostname

hostname?: pulumi.Input<string>;

Github hostname to connect. Default github.com (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection. Default true (bool)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

interface AuthConfigKeycloakArgs

interface AuthConfigKeycloakArgs

The set of arguments for constructing a AuthConfigKeycloak resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField: pulumi.Input<string>;

KeyCloak display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField: pulumi.Input<string>;

KeyCloak group field (string)

property idpMetadataContent

idpMetadataContent: pulumi.Input<string>;

KeyCloak IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property rancherApiHost

rancherApiHost: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert: pulumi.Input<string>;

KeyCloak SP cert (string)

property spKey

spKey: pulumi.Input<string>;

KeyCloak SP key (string)

property uidField

uidField: pulumi.Input<string>;

KeyCloak UID field (string)

property userNameField

userNameField: pulumi.Input<string>;

KeyCloak user name field (string)

interface AuthConfigKeycloakState

interface AuthConfigKeycloakState

Input properties used for looking up and filtering AuthConfigKeycloak resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField?: pulumi.Input<string>;

KeyCloak display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField?: pulumi.Input<string>;

KeyCloak group field (string)

property idpMetadataContent

idpMetadataContent?: pulumi.Input<string>;

KeyCloak IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property rancherApiHost

rancherApiHost?: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert?: pulumi.Input<string>;

KeyCloak SP cert (string)

property spKey

spKey?: pulumi.Input<string>;

KeyCloak SP key (string)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property uidField

uidField?: pulumi.Input<string>;

KeyCloak UID field (string)

property userNameField

userNameField?: pulumi.Input<string>;

KeyCloak user name field (string)

interface AuthConfigOktaArgs

interface AuthConfigOktaArgs

The set of arguments for constructing a AuthConfigOkta resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: okta_user://<USER_ID> okta_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField: pulumi.Input<string>;

OKTA display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField: pulumi.Input<string>;

OKTA group field (string)

property idpMetadataContent

idpMetadataContent: pulumi.Input<string>;

OKTA IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property rancherApiHost

rancherApiHost: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert: pulumi.Input<string>;

OKTA SP cert (string)

property spKey

spKey: pulumi.Input<string>;

OKTA SP key (string)

property uidField

uidField: pulumi.Input<string>;

OKTA UID field (string)

property userNameField

userNameField: pulumi.Input<string>;

OKTA user name field (string)

interface AuthConfigOktaState

interface AuthConfigOktaState

Input properties used for looking up and filtering AuthConfigOkta resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: okta_user://<USER_ID> okta_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField?: pulumi.Input<string>;

OKTA display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField?: pulumi.Input<string>;

OKTA group field (string)

property idpMetadataContent

idpMetadataContent?: pulumi.Input<string>;

OKTA IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property rancherApiHost

rancherApiHost?: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert?: pulumi.Input<string>;

OKTA SP cert (string)

property spKey

spKey?: pulumi.Input<string>;

OKTA SP key (string)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property uidField

uidField?: pulumi.Input<string>;

OKTA UID field (string)

property userNameField

userNameField?: pulumi.Input<string>;

OKTA user name field (string)

interface AuthConfigOpenLdapArgs

interface AuthConfigOpenLdapArgs

The set of arguments for constructing a AuthConfigOpenLdap resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

certificate?: pulumi.Input<string>;

Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

property connectionTimeout

connectionTimeout?: pulumi.Input<number>;

OpenLdap connection timeout. Default 5000 (int)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

groupDnAttribute?: pulumi.Input<string>;

Group DN attribute. Default entryDN (string)

property groupMemberMappingAttribute

groupMemberMappingAttribute?: pulumi.Input<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

groupMemberUserAttribute?: pulumi.Input<string>;

Group member user attribute. Default entryDN (string)

property groupNameAttribute

groupNameAttribute?: pulumi.Input<string>;

Group name attribute. Default cn (string)

property groupObjectClass

groupObjectClass?: pulumi.Input<string>;

Group object class. Default groupOfNames (string)

property groupSearchAttribute

groupSearchAttribute?: pulumi.Input<string>;

Group search attribute. Default cn (string)

property groupSearchBase

groupSearchBase?: pulumi.Input<string>;

Group search base (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property nestedGroupMembershipEnabled

nestedGroupMembershipEnabled?: pulumi.Input<boolean>;

Nested group membership enable. Default false (bool)

property port

port?: pulumi.Input<number>;

OpenLdap port. Default 389 (int)

property servers

servers: pulumi.Input<pulumi.Input<string>[]>;

OpenLdap servers list (list)

property serviceAccountDistinguishedName

serviceAccountDistinguishedName: pulumi.Input<string>;

Service account DN for access OpenLdap service (string)

property serviceAccountPassword

serviceAccountPassword: pulumi.Input<string>;

Service account password for access OpenLdap service (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection (bool)

property userDisabledBitMask

userDisabledBitMask?: pulumi.Input<number>;

User disabled bit mask (int)

property userEnabledAttribute

userEnabledAttribute?: pulumi.Input<string>;

User enable attribute (string)

property userLoginAttribute

userLoginAttribute?: pulumi.Input<string>;

User login attribute. Default uid (string)

property userMemberAttribute

userMemberAttribute?: pulumi.Input<string>;

User member attribute. Default memberOf (string)

property userNameAttribute

userNameAttribute?: pulumi.Input<string>;

User name attribute. Default givenName (string)

property userObjectClass

userObjectClass?: pulumi.Input<string>;

User object class. Default inetorgperson (string)

property userSearchAttribute

userSearchAttribute?: pulumi.Input<string>;

User search attribute. Default uid|sn|givenName (string)

property userSearchBase

userSearchBase: pulumi.Input<string>;

User search base DN (string)

interface AuthConfigOpenLdapState

interface AuthConfigOpenLdapState

Input properties used for looking up and filtering AuthConfigOpenLdap resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property certificate

certificate?: pulumi.Input<string>;

Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

property connectionTimeout

connectionTimeout?: pulumi.Input<number>;

OpenLdap connection timeout. Default 5000 (int)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupDnAttribute

groupDnAttribute?: pulumi.Input<string>;

Group DN attribute. Default entryDN (string)

property groupMemberMappingAttribute

groupMemberMappingAttribute?: pulumi.Input<string>;

Group member mapping attribute. Default member (string)

property groupMemberUserAttribute

groupMemberUserAttribute?: pulumi.Input<string>;

Group member user attribute. Default entryDN (string)

property groupNameAttribute

groupNameAttribute?: pulumi.Input<string>;

Group name attribute. Default cn (string)

property groupObjectClass

groupObjectClass?: pulumi.Input<string>;

Group object class. Default groupOfNames (string)

property groupSearchAttribute

groupSearchAttribute?: pulumi.Input<string>;

Group search attribute. Default cn (string)

property groupSearchBase

groupSearchBase?: pulumi.Input<string>;

Group search base (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property nestedGroupMembershipEnabled

nestedGroupMembershipEnabled?: pulumi.Input<boolean>;

Nested group membership enable. Default false (bool)

property port

port?: pulumi.Input<number>;

OpenLdap port. Default 389 (int)

property servers

servers?: pulumi.Input<pulumi.Input<string>[]>;

OpenLdap servers list (list)

property serviceAccountDistinguishedName

serviceAccountDistinguishedName?: pulumi.Input<string>;

Service account DN for access OpenLdap service (string)

property serviceAccountPassword

serviceAccountPassword?: pulumi.Input<string>;

Service account password for access OpenLdap service (string)

property tls

tls?: pulumi.Input<boolean>;

Enable TLS connection (bool)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property userDisabledBitMask

userDisabledBitMask?: pulumi.Input<number>;

User disabled bit mask (int)

property userEnabledAttribute

userEnabledAttribute?: pulumi.Input<string>;

User enable attribute (string)

property userLoginAttribute

userLoginAttribute?: pulumi.Input<string>;

User login attribute. Default uid (string)

property userMemberAttribute

userMemberAttribute?: pulumi.Input<string>;

User member attribute. Default memberOf (string)

property userNameAttribute

userNameAttribute?: pulumi.Input<string>;

User name attribute. Default givenName (string)

property userObjectClass

userObjectClass?: pulumi.Input<string>;

User object class. Default inetorgperson (string)

property userSearchAttribute

userSearchAttribute?: pulumi.Input<string>;

User search attribute. Default uid|sn|givenName (string)

property userSearchBase

userSearchBase?: pulumi.Input<string>;

User search base DN (string)

interface AuthConfigPingArgs

interface AuthConfigPingArgs

The set of arguments for constructing a AuthConfigPing resource.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField: pulumi.Input<string>;

Ping display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField: pulumi.Input<string>;

Ping group field (string)

property idpMetadataContent

idpMetadataContent: pulumi.Input<string>;

Ping IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property rancherApiHost

rancherApiHost: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert: pulumi.Input<string>;

Ping SP cert (string)

property spKey

spKey: pulumi.Input<string>;

Ping SP key (string)

property uidField

uidField: pulumi.Input<string>;

Ping UID field (string)

property userNameField

userNameField: pulumi.Input<string>;

Ping user name field (string)

interface AuthConfigPingState

interface AuthConfigPingState

Input properties used for looking up and filtering AuthConfigPing resources.

property accessMode

accessMode?: pulumi.Input<string>;

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

property allowedPrincipalIds

allowedPrincipalIds?: pulumi.Input<pulumi.Input<string>[]>;

Allowed principal ids for auth. Required if accessMode is required or restricted. Ex: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations of the resource (map)

property displayNameField

displayNameField?: pulumi.Input<string>;

Ping display name field (string)

property enabled

enabled?: pulumi.Input<boolean>;

Enable auth config provider. Default true (bool)

property groupsField

groupsField?: pulumi.Input<string>;

Ping group field (string)

property idpMetadataContent

idpMetadataContent?: pulumi.Input<string>;

Ping IDP metadata content (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels of the resource (map)

property name

name?: pulumi.Input<string>;

(Computed) The name of the resource (string)

property rancherApiHost

rancherApiHost?: pulumi.Input<string>;

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

property spCert

spCert?: pulumi.Input<string>;

Ping SP cert (string)

property spKey

spKey?: pulumi.Input<string>;

Ping SP key (string)

property type

type?: pulumi.Input<string>;

(Computed) The type of the resource (string)

property uidField

uidField?: pulumi.Input<string>;

Ping UID field (string)

property userNameField

userNameField?: pulumi.Input<string>;

Ping user name field (string)

interface BootstrapArgs

interface BootstrapArgs

The set of arguments for constructing a Bootstrap resource.

property currentPassword

currentPassword?: pulumi.Input<string>;

Current password for Admin user. Just needed for recover if admin password has been changed from other resources and token is expired (string)

property password

password?: pulumi.Input<string>;

Password for Admin user or random generated if empty (string)

property telemetry

telemetry?: pulumi.Input<boolean>;

Send telemetry anonymous data. Default: false (bool)

property tokenTtl

tokenTtl?: pulumi.Input<number>;

TTL in seconds for generated admin token. Default: 0 (int)

property tokenUpdate

tokenUpdate?: pulumi.Input<boolean>;

Regenerate admin token. Default: false (bool)

interface BootstrapState

interface BootstrapState

Input properties used for looking up and filtering Bootstrap resources.

property currentPassword

currentPassword?: pulumi.Input<string>;

Current password for Admin user. Just needed for recover if admin password has been changed from other resources and token is expired (string)

property password

password?: pulumi.Input<string>;

Password for Admin user or random generated if empty (string)

property telemetry

telemetry?: pulumi.Input<boolean>;

Send telemetry anonymous data. Default: false (bool)

property tempToken

tempToken?: pulumi.Input<string>;

(Computed) Generated API temporary token as helper. Should be empty (string)

property tempTokenId

tempTokenId?: pulumi.Input<string>;

(Computed) Generated API temporary token id as helper. Should be empty (string)

property token

token?: pulumi.Input<string>;

(Computed) Generated API token for Admin User (string)

property tokenId

tokenId?: pulumi.Input<string>;

(Computed) Generated API token id for Admin User (string)

property tokenTtl

tokenTtl?: pulumi.Input<number>;

TTL in seconds for generated admin token. Default: 0 (int)

property tokenUpdate

tokenUpdate?: pulumi.Input<boolean>;

Regenerate admin token. Default: false (bool)

property url

url?: pulumi.Input<string>;

(Computed) URL set as server-url (string)

property user

user?: pulumi.Input<string>;

(Computed) Admin username (string)

interface CatalogArgs

interface CatalogArgs

The set of arguments for constructing a Catalog resource.

property annotations

annotations?: pulumi.Input<{[key: string]: any}>;

Annotations for the catalog (map)

property branch

branch?: pulumi.Input<string>;

The branch of the catalog repo to use. Default master (string)

property clusterId

clusterId?: pulumi.Input<string>;

The cluster id of the catalog. Mandatory if scope = cluster (string)

property description

description?: pulumi.Input<string>;

A catalog description (string)

property kind

kind?: pulumi.Input<string>;

The kind of the catalog. Just helm by the moment (string)

property labels

labels?: pulumi.Input<{[key: string]: any}>;

Labels for the catalog (map)

property name

name?: pulumi.Input<string>;

The name of the catalog (string)

property password

password?: pulumi.Input<string>;

The password to access the catalog if needed (string)

property projectId

projectId?: pulumi.Input<string>;

The project id of the catalog. Mandatory if scope = project (string)