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.

class pulumi_rancher2.ActiveDirectory(resource_name, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, certificate=None, connection_timeout=None, default_login_domain=None, enabled=None, group_dn_attribute=None, group_member_mapping_attribute=None, group_member_user_attribute=None, group_name_attribute=None, group_object_class=None, group_search_attribute=None, group_search_base=None, group_search_filter=None, labels=None, nested_group_membership_enabled=None, port=None, servers=None, service_account_password=None, service_account_username=None, tls=None, user_disabled_bit_mask=None, user_enabled_attribute=None, user_login_attribute=None, user_name_attribute=None, user_object_class=None, user_search_attribute=None, user_search_base=None, user_search_filter=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: activedirectory_user://<DN> activedirectory_group://<DN> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • certificate (pulumi.Input[str]) – CA certificate for TLS if selfsigned (string)

  • connection_timeout (pulumi.Input[float]) – ActiveDirectory connection timeout. Default 5000 (int)

  • default_login_domain (pulumi.Input[str]) – ActiveDirectory defult lgoin domain (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • group_dn_attribute (pulumi.Input[str]) – Group DN attribute. Default distinguishedName (string)

  • group_member_mapping_attribute (pulumi.Input[str]) – Group member mapping attribute. Default member (string)

  • group_member_user_attribute (pulumi.Input[str]) – Group member user attribute. Default distinguishedName (string)

  • group_name_attribute (pulumi.Input[str]) – Group name attribute. Default name (string)

  • group_object_class (pulumi.Input[str]) – Group object class. Default group (string)

  • group_search_attribute (pulumi.Input[str]) – Group search attribute. Default sAMAccountName (string)

  • group_search_base (pulumi.Input[str]) – Group search base (string)

  • group_search_filter (pulumi.Input[str]) – Group search filter (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • nested_group_membership_enabled (pulumi.Input[bool]) – Nested group membership enable. Default false (bool)

  • port (pulumi.Input[float]) – ActiveDirectory port. Default 389 (int)

  • servers (pulumi.Input[list]) – ActiveDirectory servers list (list)

  • service_account_password (pulumi.Input[str]) – Service account password for access ActiveDirectory service (string)

  • service_account_username (pulumi.Input[str]) – Service account DN for access ActiveDirectory service (string)

  • tls (pulumi.Input[bool]) – Enable TLS connection (bool)

  • user_disabled_bit_mask (pulumi.Input[float]) – User disabled bit mask. Default 2 (int)

  • user_enabled_attribute (pulumi.Input[str]) – User enable attribute (string)

  • user_login_attribute (pulumi.Input[str]) – User login attribute. Default sAMAccountName (string)

  • user_name_attribute (pulumi.Input[str]) – User name attribute. Default name (string)

  • user_object_class (pulumi.Input[str]) – User object class. Default person (string)

  • user_search_attribute (pulumi.Input[str]) – User search attribute. Default sAMAccountName|sn|givenName (string)

  • user_search_base (pulumi.Input[str]) – User search base DN (string)

  • user_search_filter (pulumi.Input[str]) – User search filter (string)

access_mode = None

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

allowed_principal_ids = None

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

annotations = None

Annotations of the resource (map)

certificate = None

CA certificate for TLS if selfsigned (string)

connection_timeout = None

ActiveDirectory connection timeout. Default 5000 (int)

default_login_domain = None

ActiveDirectory defult lgoin domain (string)

enabled = None

Enable auth config provider. Default true (bool)

group_dn_attribute = None

Group DN attribute. Default distinguishedName (string)

group_member_mapping_attribute = None

Group member mapping attribute. Default member (string)

group_member_user_attribute = None

Group member user attribute. Default distinguishedName (string)

group_name_attribute = None

Group name attribute. Default name (string)

group_object_class = None

Group object class. Default group (string)

group_search_attribute = None

Group search attribute. Default sAMAccountName (string)

group_search_base = None

Group search base (string)

group_search_filter = None

Group search filter (string)

labels = None

Labels of the resource (map)

name = None

(Computed) The name of the resource (string)

nested_group_membership_enabled = None

Nested group membership enable. Default false (bool)

port = None

ActiveDirectory port. Default 389 (int)

servers = None

ActiveDirectory servers list (list)

service_account_password = None

Service account password for access ActiveDirectory service (string)

service_account_username = None

Service account DN for access ActiveDirectory service (string)

tls = None

Enable TLS connection (bool)

type = None

(Computed) The type of the resource (string)

user_disabled_bit_mask = None

User disabled bit mask. Default 2 (int)

user_enabled_attribute = None

User enable attribute (string)

user_login_attribute = None

User login attribute. Default sAMAccountName (string)

user_name_attribute = None

User name attribute. Default name (string)

user_object_class = None

User object class. Default person (string)

user_search_attribute = None

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

user_search_base = None

User search base DN (string)

user_search_filter = None

User search filter (string)

static get(resource_name, id, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, certificate=None, connection_timeout=None, default_login_domain=None, enabled=None, group_dn_attribute=None, group_member_mapping_attribute=None, group_member_user_attribute=None, group_name_attribute=None, group_object_class=None, group_search_attribute=None, group_search_base=None, group_search_filter=None, labels=None, name=None, nested_group_membership_enabled=None, port=None, servers=None, service_account_password=None, service_account_username=None, tls=None, type=None, user_disabled_bit_mask=None, user_enabled_attribute=None, user_login_attribute=None, user_name_attribute=None, user_object_class=None, user_search_attribute=None, user_search_base=None, user_search_filter=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: activedirectory_user://<DN> activedirectory_group://<DN> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • certificate (pulumi.Input[str]) – CA certificate for TLS if selfsigned (string)

  • connection_timeout (pulumi.Input[float]) – ActiveDirectory connection timeout. Default 5000 (int)

  • default_login_domain (pulumi.Input[str]) – ActiveDirectory defult lgoin domain (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • group_dn_attribute (pulumi.Input[str]) – Group DN attribute. Default distinguishedName (string)

  • group_member_mapping_attribute (pulumi.Input[str]) – Group member mapping attribute. Default member (string)

  • group_member_user_attribute (pulumi.Input[str]) – Group member user attribute. Default distinguishedName (string)

  • group_name_attribute (pulumi.Input[str]) – Group name attribute. Default name (string)

  • group_object_class (pulumi.Input[str]) – Group object class. Default group (string)

  • group_search_attribute (pulumi.Input[str]) – Group search attribute. Default sAMAccountName (string)

  • group_search_base (pulumi.Input[str]) – Group search base (string)

  • group_search_filter (pulumi.Input[str]) – Group search filter (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • name (pulumi.Input[str]) – (Computed) The name of the resource (string)

  • nested_group_membership_enabled (pulumi.Input[bool]) – Nested group membership enable. Default false (bool)

  • port (pulumi.Input[float]) – ActiveDirectory port. Default 389 (int)

  • servers (pulumi.Input[list]) – ActiveDirectory servers list (list)

  • service_account_password (pulumi.Input[str]) – Service account password for access ActiveDirectory service (string)

  • service_account_username (pulumi.Input[str]) – Service account DN for access ActiveDirectory service (string)

  • tls (pulumi.Input[bool]) – Enable TLS connection (bool)

  • type (pulumi.Input[str]) – (Computed) The type of the resource (string)

  • user_disabled_bit_mask (pulumi.Input[float]) – User disabled bit mask. Default 2 (int)

  • user_enabled_attribute (pulumi.Input[str]) – User enable attribute (string)

  • user_login_attribute (pulumi.Input[str]) – User login attribute. Default sAMAccountName (string)

  • user_name_attribute (pulumi.Input[str]) – User name attribute. Default name (string)

  • user_object_class (pulumi.Input[str]) – User object class. Default person (string)

  • user_search_attribute (pulumi.Input[str]) – User search attribute. Default sAMAccountName|sn|givenName (string)

  • user_search_base (pulumi.Input[str]) – User search base DN (string)

  • user_search_filter (pulumi.Input[str]) – User search filter (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.App(resource_name, opts=None, annotations=None, answers=None, catalog_name=None, description=None, force_upgrade=None, labels=None, name=None, project_id=None, revision_id=None, target_namespace=None, template_name=None, template_version=None, values_yaml=None, __props__=None, __name__=None, __opts__=None)

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

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for App object (map)

  • answers (pulumi.Input[dict]) – Answers for the app template. If modified, app will be upgraded (map)

  • catalog_name (pulumi.Input[str]) – 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>`
Parameters
  • description (pulumi.Input[str]) – Description for the app (string)

  • force_upgrade (pulumi.Input[bool]) – Force app upgrade (string)

  • labels (pulumi.Input[dict]) – Labels for App object (map)

  • name (pulumi.Input[str]) – The name of the app (string)

  • project_id (pulumi.Input[str]) – The project id where the app will be installed (string)

  • revision_id (pulumi.Input[str]) – Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

  • target_namespace (pulumi.Input[str]) – The namespace name where the app will be installed (string)

  • template_name (pulumi.Input[str]) – Template name of the app. If modified, app will be upgraded (string)

  • template_version (pulumi.Input[str]) – Template version of the app. If modified, app will be upgraded. Default: latest (string)

  • values_yaml (pulumi.Input[str]) – values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

annotations = None

Annotations for App object (map)

answers = None

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

catalog_name = None

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>

description = None

Description for the app (string)

external_id = None

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

force_upgrade = None

Force app upgrade (string)

labels = None

Labels for App object (map)

name = None

The name of the app (string)

project_id = None

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

revision_id = None

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

target_namespace = None

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

template_name = None

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

template_version = None

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

values_yaml = None

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

static get(resource_name, id, opts=None, annotations=None, answers=None, catalog_name=None, description=None, external_id=None, force_upgrade=None, labels=None, name=None, project_id=None, revision_id=None, target_namespace=None, template_name=None, template_version=None, values_yaml=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for App object (map)

  • answers (pulumi.Input[dict]) – Answers for the app template. If modified, app will be upgraded (map)

  • catalog_name (pulumi.Input[str]) – 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>`
Parameters
  • description (pulumi.Input[str]) – Description for the app (string)

  • external_id (pulumi.Input[str]) – (Computed) The url of the app template on a catalog (string)

  • force_upgrade (pulumi.Input[bool]) – Force app upgrade (string)

  • labels (pulumi.Input[dict]) – Labels for App object (map)

  • name (pulumi.Input[str]) – The name of the app (string)

  • project_id (pulumi.Input[str]) – The project id where the app will be installed (string)

  • revision_id (pulumi.Input[str]) – Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

  • target_namespace (pulumi.Input[str]) – The namespace name where the app will be installed (string)

  • template_name (pulumi.Input[str]) – Template name of the app. If modified, app will be upgraded (string)

  • template_version (pulumi.Input[str]) – Template version of the app. If modified, app will be upgraded. Default: latest (string)

  • values_yaml (pulumi.Input[str]) – values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.AuthConfigAdfs(resource_name, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, display_name_field=None, enabled=None, groups_field=None, idp_metadata_content=None, labels=None, rancher_api_host=None, sp_cert=None, sp_key=None, uid_field=None, user_name_field=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • display_name_field (pulumi.Input[str]) – ADFS display name field (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • groups_field (pulumi.Input[str]) – ADFS group field (string)

  • idp_metadata_content (pulumi.Input[str]) – ADFS IDP metadata content (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • rancher_api_host (pulumi.Input[str]) – Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

  • sp_cert (pulumi.Input[str]) – ADFS SP cert (string)

  • sp_key (pulumi.Input[str]) – ADFS SP key (string)

  • uid_field (pulumi.Input[str]) – ADFS UID field (string)

  • user_name_field (pulumi.Input[str]) – ADFS user name field (string)

access_mode = None

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

allowed_principal_ids = None

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

annotations = None

Annotations of the resource (map)

display_name_field = None

ADFS display name field (string)

enabled = None

Enable auth config provider. Default true (bool)

groups_field = None

ADFS group field (string)

idp_metadata_content = None

ADFS IDP metadata content (string)

labels = None

Labels of the resource (map)

name = None

(Computed) The name of the resource (string)

rancher_api_host = None

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

sp_cert = None

ADFS SP cert (string)

sp_key = None

ADFS SP key (string)

type = None

(Computed) The type of the resource (string)

uid_field = None

ADFS UID field (string)

user_name_field = None

ADFS user name field (string)

static get(resource_name, id, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, display_name_field=None, enabled=None, groups_field=None, idp_metadata_content=None, labels=None, name=None, rancher_api_host=None, sp_cert=None, sp_key=None, type=None, uid_field=None, user_name_field=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: adfs_user://<USER_ID> adfs_group://<GROUP_ID> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • display_name_field (pulumi.Input[str]) – ADFS display name field (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • groups_field (pulumi.Input[str]) – ADFS group field (string)

  • idp_metadata_content (pulumi.Input[str]) – ADFS IDP metadata content (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • name (pulumi.Input[str]) – (Computed) The name of the resource (string)

  • rancher_api_host (pulumi.Input[str]) – Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

  • sp_cert (pulumi.Input[str]) – ADFS SP cert (string)

  • sp_key (pulumi.Input[str]) – ADFS SP key (string)

  • type (pulumi.Input[str]) – (Computed) The type of the resource (string)

  • uid_field (pulumi.Input[str]) – ADFS UID field (string)

  • user_name_field (pulumi.Input[str]) – ADFS user name field (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.AuthConfigAzureAd(resource_name, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, application_id=None, application_secret=None, auth_endpoint=None, enabled=None, endpoint=None, graph_endpoint=None, labels=None, rancher_url=None, tenant_id=None, token_endpoint=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: azuread_user://<USER_ID> azuread_group://<GROUP_ID> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • application_id (pulumi.Input[str]) – AzureAD auth application ID (string)

  • application_secret (pulumi.Input[str]) – AzureAD auth application secret (string)

  • auth_endpoint (pulumi.Input[str]) – AzureAD auth endpoint (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • endpoint (pulumi.Input[str]) – AzureAD endpoint. Default https://login.microsoftonline.com/ (string)

  • graph_endpoint (pulumi.Input[str]) – AzureAD graph endpoint (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • rancher_url (pulumi.Input[str]) – Rancher URL (string). “/verify-auth-azure”

  • tenant_id (pulumi.Input[str]) – AzureAD tenant ID (string)

  • token_endpoint (pulumi.Input[str]) – AzureAD token endpoint (string)

access_mode = None

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

allowed_principal_ids = None

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

annotations = None

Annotations of the resource (map)

application_id = None

AzureAD auth application ID (string)

application_secret = None

AzureAD auth application secret (string)

auth_endpoint = None

AzureAD auth endpoint (string)

enabled = None

Enable auth config provider. Default true (bool)

endpoint = None

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

graph_endpoint = None

AzureAD graph endpoint (string)

labels = None

Labels of the resource (map)

name = None

(Computed) The name of the resource (string)

rancher_url = None

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

tenant_id = None

AzureAD tenant ID (string)

token_endpoint = None

AzureAD token endpoint (string)

type = None

(Computed) The type of the resource (string)

static get(resource_name, id, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, application_id=None, application_secret=None, auth_endpoint=None, enabled=None, endpoint=None, graph_endpoint=None, labels=None, name=None, rancher_url=None, tenant_id=None, token_endpoint=None, type=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: azuread_user://<USER_ID> azuread_group://<GROUP_ID> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • application_id (pulumi.Input[str]) – AzureAD auth application ID (string)

  • application_secret (pulumi.Input[str]) – AzureAD auth application secret (string)

  • auth_endpoint (pulumi.Input[str]) – AzureAD auth endpoint (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • endpoint (pulumi.Input[str]) – AzureAD endpoint. Default https://login.microsoftonline.com/ (string)

  • graph_endpoint (pulumi.Input[str]) – AzureAD graph endpoint (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • name (pulumi.Input[str]) – (Computed) The name of the resource (string)

  • rancher_url (pulumi.Input[str]) – Rancher URL (string). “/verify-auth-azure”

  • tenant_id (pulumi.Input[str]) – AzureAD tenant ID (string)

  • token_endpoint (pulumi.Input[str]) – AzureAD token endpoint (string)

  • type (pulumi.Input[str]) – (Computed) The type of the resource (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.AuthConfigFreeIpa(resource_name, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, certificate=None, connection_timeout=None, enabled=None, group_dn_attribute=None, group_member_mapping_attribute=None, group_member_user_attribute=None, group_name_attribute=None, group_object_class=None, group_search_attribute=None, group_search_base=None, labels=None, nested_group_membership_enabled=None, port=None, servers=None, service_account_distinguished_name=None, service_account_password=None, tls=None, user_disabled_bit_mask=None, user_enabled_attribute=None, user_login_attribute=None, user_member_attribute=None, user_name_attribute=None, user_object_class=None, user_search_attribute=None, user_search_base=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: freeipa_user://<DN> freeipa_group://<DN> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • certificate (pulumi.Input[str]) – Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

  • connection_timeout (pulumi.Input[float]) – FreeIpa connection timeout. Default 5000 (int)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • group_dn_attribute (pulumi.Input[str]) – Group DN attribute. Default entryDN (string)

  • group_member_mapping_attribute (pulumi.Input[str]) – Group member mapping attribute. Default member (string)

  • group_member_user_attribute (pulumi.Input[str]) – Group member user attribute. Default entryDN (string)

  • group_name_attribute (pulumi.Input[str]) – Group name attribute. Default cn (string)

  • group_object_class (pulumi.Input[str]) – Group object class. Default groupOfNames (string)

  • group_search_attribute (pulumi.Input[str]) – Group search attribute. Default cn (string)

  • group_search_base (pulumi.Input[str]) – Group search base (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • nested_group_membership_enabled (pulumi.Input[bool]) – Nested group membership enable. Default false (bool)

  • port (pulumi.Input[float]) – FreeIpa port. Default 389 (int)

  • servers (pulumi.Input[list]) – FreeIpa servers list (list)

  • service_account_distinguished_name (pulumi.Input[str]) – Service account DN for access FreeIpa service (string)

  • service_account_password (pulumi.Input[str]) – Service account password for access FreeIpa service (string)

  • tls (pulumi.Input[bool]) – Enable TLS connection (bool)

  • user_disabled_bit_mask (pulumi.Input[float]) – User disabled bit mask (int)

  • user_enabled_attribute (pulumi.Input[str]) – User enable attribute (string)

  • user_login_attribute (pulumi.Input[str]) – User login attribute. Default uid (string)

  • user_member_attribute (pulumi.Input[str]) – User member attribute. Default memberOf (string)

  • user_name_attribute (pulumi.Input[str]) – User name attribute. Default givenName (string)

  • user_object_class (pulumi.Input[str]) – User object class. Default inetorgperson (string)

  • user_search_attribute (pulumi.Input[str]) – User search attribute. Default uid|sn|givenName (string)

  • user_search_base (pulumi.Input[str]) – User search base DN (string)

access_mode = None

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

allowed_principal_ids = None

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

annotations = None

Annotations of the resource (map)

certificate = None

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

connection_timeout = None

FreeIpa connection timeout. Default 5000 (int)

enabled = None

Enable auth config provider. Default true (bool)

group_dn_attribute = None

Group DN attribute. Default entryDN (string)

group_member_mapping_attribute = None

Group member mapping attribute. Default member (string)

group_member_user_attribute = None

Group member user attribute. Default entryDN (string)

group_name_attribute = None

Group name attribute. Default cn (string)

group_object_class = None

Group object class. Default groupOfNames (string)

group_search_attribute = None

Group search attribute. Default cn (string)

group_search_base = None

Group search base (string)

labels = None

Labels of the resource (map)

name = None

(Computed) The name of the resource (string)

nested_group_membership_enabled = None

Nested group membership enable. Default false (bool)

port = None

FreeIpa port. Default 389 (int)

servers = None

FreeIpa servers list (list)

service_account_distinguished_name = None

Service account DN for access FreeIpa service (string)

service_account_password = None

Service account password for access FreeIpa service (string)

tls = None

Enable TLS connection (bool)

type = None

(Computed) The type of the resource (string)

user_disabled_bit_mask = None

User disabled bit mask (int)

user_enabled_attribute = None

User enable attribute (string)

user_login_attribute = None

User login attribute. Default uid (string)

user_member_attribute = None

User member attribute. Default memberOf (string)

user_name_attribute = None

User name attribute. Default givenName (string)

user_object_class = None

User object class. Default inetorgperson (string)

user_search_attribute = None

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

user_search_base = None

User search base DN (string)

static get(resource_name, id, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, certificate=None, connection_timeout=None, enabled=None, group_dn_attribute=None, group_member_mapping_attribute=None, group_member_user_attribute=None, group_name_attribute=None, group_object_class=None, group_search_attribute=None, group_search_base=None, labels=None, name=None, nested_group_membership_enabled=None, port=None, servers=None, service_account_distinguished_name=None, service_account_password=None, tls=None, type=None, user_disabled_bit_mask=None, user_enabled_attribute=None, user_login_attribute=None, user_member_attribute=None, user_name_attribute=None, user_object_class=None, user_search_attribute=None, user_search_base=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: freeipa_user://<DN> freeipa_group://<DN> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • certificate (pulumi.Input[str]) – Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

  • connection_timeout (pulumi.Input[float]) – FreeIpa connection timeout. Default 5000 (int)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • group_dn_attribute (pulumi.Input[str]) – Group DN attribute. Default entryDN (string)

  • group_member_mapping_attribute (pulumi.Input[str]) – Group member mapping attribute. Default member (string)

  • group_member_user_attribute (pulumi.Input[str]) – Group member user attribute. Default entryDN (string)

  • group_name_attribute (pulumi.Input[str]) – Group name attribute. Default cn (string)

  • group_object_class (pulumi.Input[str]) – Group object class. Default groupOfNames (string)

  • group_search_attribute (pulumi.Input[str]) – Group search attribute. Default cn (string)

  • group_search_base (pulumi.Input[str]) – Group search base (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • name (pulumi.Input[str]) – (Computed) The name of the resource (string)

  • nested_group_membership_enabled (pulumi.Input[bool]) – Nested group membership enable. Default false (bool)

  • port (pulumi.Input[float]) – FreeIpa port. Default 389 (int)

  • servers (pulumi.Input[list]) – FreeIpa servers list (list)

  • service_account_distinguished_name (pulumi.Input[str]) – Service account DN for access FreeIpa service (string)

  • service_account_password (pulumi.Input[str]) – Service account password for access FreeIpa service (string)

  • tls (pulumi.Input[bool]) – Enable TLS connection (bool)

  • type (pulumi.Input[str]) – (Computed) The type of the resource (string)

  • user_disabled_bit_mask (pulumi.Input[float]) – User disabled bit mask (int)

  • user_enabled_attribute (pulumi.Input[str]) – User enable attribute (string)

  • user_login_attribute (pulumi.Input[str]) – User login attribute. Default uid (string)

  • user_member_attribute (pulumi.Input[str]) – User member attribute. Default memberOf (string)

  • user_name_attribute (pulumi.Input[str]) – User name attribute. Default givenName (string)

  • user_object_class (pulumi.Input[str]) – User object class. Default inetorgperson (string)

  • user_search_attribute (pulumi.Input[str]) – User search attribute. Default uid|sn|givenName (string)

  • user_search_base (pulumi.Input[str]) – User search base DN (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.AuthConfigGithub(resource_name, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, client_id=None, client_secret=None, enabled=None, hostname=None, labels=None, tls=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: github_user://<USER_ID> github_team://<GROUP_ID> github_org://<ORG_ID> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • client_id (pulumi.Input[str]) – Github auth Client ID (string)

  • client_secret (pulumi.Input[str]) – Github auth Client secret (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • hostname (pulumi.Input[str]) – Github hostname to connect. Default github.com (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • tls (pulumi.Input[bool]) – Enable TLS connection. Default true (bool)

access_mode = None

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

allowed_principal_ids = None

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

annotations = None

Annotations of the resource (map)

client_id = None

Github auth Client ID (string)

client_secret = None

Github auth Client secret (string)

enabled = None

Enable auth config provider. Default true (bool)

hostname = None

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

labels = None

Labels of the resource (map)

name = None

(Computed) The name of the resource (string)

tls = None

Enable TLS connection. Default true (bool)

type = None

(Computed) The type of the resource (string)

static get(resource_name, id, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, client_id=None, client_secret=None, enabled=None, hostname=None, labels=None, name=None, tls=None, type=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: github_user://<USER_ID> github_team://<GROUP_ID> github_org://<ORG_ID> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • client_id (pulumi.Input[str]) – Github auth Client ID (string)

  • client_secret (pulumi.Input[str]) – Github auth Client secret (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • hostname (pulumi.Input[str]) – Github hostname to connect. Default github.com (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • name (pulumi.Input[str]) – (Computed) The name of the resource (string)

  • tls (pulumi.Input[bool]) – Enable TLS connection. Default true (bool)

  • type (pulumi.Input[str]) – (Computed) The type of the resource (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.AuthConfigKeycloak(resource_name, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, display_name_field=None, enabled=None, groups_field=None, idp_metadata_content=None, labels=None, rancher_api_host=None, sp_cert=None, sp_key=None, uid_field=None, user_name_field=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • display_name_field (pulumi.Input[str]) – KeyCloak display name field (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • groups_field (pulumi.Input[str]) – KeyCloak group field (string)

  • idp_metadata_content (pulumi.Input[str]) – KeyCloak IDP metadata content (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • rancher_api_host (pulumi.Input[str]) – Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

  • sp_cert (pulumi.Input[str]) – KeyCloak SP cert (string)

  • sp_key (pulumi.Input[str]) – KeyCloak SP key (string)

  • uid_field (pulumi.Input[str]) – KeyCloak UID field (string)

  • user_name_field (pulumi.Input[str]) – KeyCloak user name field (string)

access_mode = None

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

allowed_principal_ids = None

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

annotations = None

Annotations of the resource (map)

display_name_field = None

KeyCloak display name field (string)

enabled = None

Enable auth config provider. Default true (bool)

groups_field = None

KeyCloak group field (string)

idp_metadata_content = None

KeyCloak IDP metadata content (string)

labels = None

Labels of the resource (map)

name = None

(Computed) The name of the resource (string)

rancher_api_host = None

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

sp_cert = None

KeyCloak SP cert (string)

sp_key = None

KeyCloak SP key (string)

type = None

(Computed) The type of the resource (string)

uid_field = None

KeyCloak UID field (string)

user_name_field = None

KeyCloak user name field (string)

static get(resource_name, id, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, display_name_field=None, enabled=None, groups_field=None, idp_metadata_content=None, labels=None, name=None, rancher_api_host=None, sp_cert=None, sp_key=None, type=None, uid_field=None, user_name_field=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: keycloak_user://<USER_ID> keycloak_group://<GROUP_ID> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • display_name_field (pulumi.Input[str]) – KeyCloak display name field (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • groups_field (pulumi.Input[str]) – KeyCloak group field (string)

  • idp_metadata_content (pulumi.Input[str]) – KeyCloak IDP metadata content (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • name (pulumi.Input[str]) – (Computed) The name of the resource (string)

  • rancher_api_host (pulumi.Input[str]) – Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

  • sp_cert (pulumi.Input[str]) – KeyCloak SP cert (string)

  • sp_key (pulumi.Input[str]) – KeyCloak SP key (string)

  • type (pulumi.Input[str]) – (Computed) The type of the resource (string)

  • uid_field (pulumi.Input[str]) – KeyCloak UID field (string)

  • user_name_field (pulumi.Input[str]) – KeyCloak user name field (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.AuthConfigOkta(resource_name, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, display_name_field=None, enabled=None, groups_field=None, idp_metadata_content=None, labels=None, rancher_api_host=None, sp_cert=None, sp_key=None, uid_field=None, user_name_field=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: okta_user://<USER_ID> okta_group://<GROUP_ID> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • display_name_field (pulumi.Input[str]) – OKTA display name field (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • groups_field (pulumi.Input[str]) – OKTA group field (string)

  • idp_metadata_content (pulumi.Input[str]) – OKTA IDP metadata content (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • rancher_api_host (pulumi.Input[str]) – Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

  • sp_cert (pulumi.Input[str]) – OKTA SP cert (string)

  • sp_key (pulumi.Input[str]) – OKTA SP key (string)

  • uid_field (pulumi.Input[str]) – OKTA UID field (string)

  • user_name_field (pulumi.Input[str]) – OKTA user name field (string)

access_mode = None

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

allowed_principal_ids = None

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

annotations = None

Annotations of the resource (map)

display_name_field = None

OKTA display name field (string)

enabled = None

Enable auth config provider. Default true (bool)

groups_field = None

OKTA group field (string)

idp_metadata_content = None

OKTA IDP metadata content (string)

labels = None

Labels of the resource (map)

name = None

(Computed) The name of the resource (string)

rancher_api_host = None

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

sp_cert = None

OKTA SP cert (string)

sp_key = None

OKTA SP key (string)

type = None

(Computed) The type of the resource (string)

uid_field = None

OKTA UID field (string)

user_name_field = None

OKTA user name field (string)

static get(resource_name, id, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, display_name_field=None, enabled=None, groups_field=None, idp_metadata_content=None, labels=None, name=None, rancher_api_host=None, sp_cert=None, sp_key=None, type=None, uid_field=None, user_name_field=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: okta_user://<USER_ID> okta_group://<GROUP_ID> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • display_name_field (pulumi.Input[str]) – OKTA display name field (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • groups_field (pulumi.Input[str]) – OKTA group field (string)

  • idp_metadata_content (pulumi.Input[str]) – OKTA IDP metadata content (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • name (pulumi.Input[str]) – (Computed) The name of the resource (string)

  • rancher_api_host (pulumi.Input[str]) – Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

  • sp_cert (pulumi.Input[str]) – OKTA SP cert (string)

  • sp_key (pulumi.Input[str]) – OKTA SP key (string)

  • type (pulumi.Input[str]) – (Computed) The type of the resource (string)

  • uid_field (pulumi.Input[str]) – OKTA UID field (string)

  • user_name_field (pulumi.Input[str]) – OKTA user name field (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.AuthConfigOpenLdap(resource_name, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, certificate=None, connection_timeout=None, enabled=None, group_dn_attribute=None, group_member_mapping_attribute=None, group_member_user_attribute=None, group_name_attribute=None, group_object_class=None, group_search_attribute=None, group_search_base=None, labels=None, nested_group_membership_enabled=None, port=None, servers=None, service_account_distinguished_name=None, service_account_password=None, tls=None, user_disabled_bit_mask=None, user_enabled_attribute=None, user_login_attribute=None, user_member_attribute=None, user_name_attribute=None, user_object_class=None, user_search_attribute=None, user_search_base=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • certificate (pulumi.Input[str]) – Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

  • connection_timeout (pulumi.Input[float]) – OpenLdap connection timeout. Default 5000 (int)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • group_dn_attribute (pulumi.Input[str]) – Group DN attribute. Default entryDN (string)

  • group_member_mapping_attribute (pulumi.Input[str]) – Group member mapping attribute. Default member (string)

  • group_member_user_attribute (pulumi.Input[str]) – Group member user attribute. Default entryDN (string)

  • group_name_attribute (pulumi.Input[str]) – Group name attribute. Default cn (string)

  • group_object_class (pulumi.Input[str]) – Group object class. Default groupOfNames (string)

  • group_search_attribute (pulumi.Input[str]) – Group search attribute. Default cn (string)

  • group_search_base (pulumi.Input[str]) – Group search base (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • nested_group_membership_enabled (pulumi.Input[bool]) – Nested group membership enable. Default false (bool)

  • port (pulumi.Input[float]) – OpenLdap port. Default 389 (int)

  • servers (pulumi.Input[list]) – OpenLdap servers list (list)

  • service_account_distinguished_name (pulumi.Input[str]) – Service account DN for access OpenLdap service (string)

  • service_account_password (pulumi.Input[str]) – Service account password for access OpenLdap service (string)

  • tls (pulumi.Input[bool]) – Enable TLS connection (bool)

  • user_disabled_bit_mask (pulumi.Input[float]) – User disabled bit mask (int)

  • user_enabled_attribute (pulumi.Input[str]) – User enable attribute (string)

  • user_login_attribute (pulumi.Input[str]) – User login attribute. Default uid (string)

  • user_member_attribute (pulumi.Input[str]) – User member attribute. Default memberOf (string)

  • user_name_attribute (pulumi.Input[str]) – User name attribute. Default givenName (string)

  • user_object_class (pulumi.Input[str]) – User object class. Default inetorgperson (string)

  • user_search_attribute (pulumi.Input[str]) – User search attribute. Default uid|sn|givenName (string)

  • user_search_base (pulumi.Input[str]) – User search base DN (string)

access_mode = None

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

allowed_principal_ids = None

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

annotations = None

Annotations of the resource (map)

certificate = None

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

connection_timeout = None

OpenLdap connection timeout. Default 5000 (int)

enabled = None

Enable auth config provider. Default true (bool)

group_dn_attribute = None

Group DN attribute. Default entryDN (string)

group_member_mapping_attribute = None

Group member mapping attribute. Default member (string)

group_member_user_attribute = None

Group member user attribute. Default entryDN (string)

group_name_attribute = None

Group name attribute. Default cn (string)

group_object_class = None

Group object class. Default groupOfNames (string)

group_search_attribute = None

Group search attribute. Default cn (string)

group_search_base = None

Group search base (string)

labels = None

Labels of the resource (map)

name = None

(Computed) The name of the resource (string)

nested_group_membership_enabled = None

Nested group membership enable. Default false (bool)

port = None

OpenLdap port. Default 389 (int)

servers = None

OpenLdap servers list (list)

service_account_distinguished_name = None

Service account DN for access OpenLdap service (string)

service_account_password = None

Service account password for access OpenLdap service (string)

tls = None

Enable TLS connection (bool)

type = None

(Computed) The type of the resource (string)

user_disabled_bit_mask = None

User disabled bit mask (int)

user_enabled_attribute = None

User enable attribute (string)

user_login_attribute = None

User login attribute. Default uid (string)

user_member_attribute = None

User member attribute. Default memberOf (string)

user_name_attribute = None

User name attribute. Default givenName (string)

user_object_class = None

User object class. Default inetorgperson (string)

user_search_attribute = None

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

user_search_base = None

User search base DN (string)

static get(resource_name, id, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, certificate=None, connection_timeout=None, enabled=None, group_dn_attribute=None, group_member_mapping_attribute=None, group_member_user_attribute=None, group_name_attribute=None, group_object_class=None, group_search_attribute=None, group_search_base=None, labels=None, name=None, nested_group_membership_enabled=None, port=None, servers=None, service_account_distinguished_name=None, service_account_password=None, tls=None, type=None, user_disabled_bit_mask=None, user_enabled_attribute=None, user_login_attribute=None, user_member_attribute=None, user_name_attribute=None, user_object_class=None, user_search_attribute=None, user_search_base=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • certificate (pulumi.Input[str]) – Base64 encoded CA certificate for TLS if self-signed. Use filebase64() for encoding file (string)

  • connection_timeout (pulumi.Input[float]) – OpenLdap connection timeout. Default 5000 (int)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • group_dn_attribute (pulumi.Input[str]) – Group DN attribute. Default entryDN (string)

  • group_member_mapping_attribute (pulumi.Input[str]) – Group member mapping attribute. Default member (string)

  • group_member_user_attribute (pulumi.Input[str]) – Group member user attribute. Default entryDN (string)

  • group_name_attribute (pulumi.Input[str]) – Group name attribute. Default cn (string)

  • group_object_class (pulumi.Input[str]) – Group object class. Default groupOfNames (string)

  • group_search_attribute (pulumi.Input[str]) – Group search attribute. Default cn (string)

  • group_search_base (pulumi.Input[str]) – Group search base (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • name (pulumi.Input[str]) – (Computed) The name of the resource (string)

  • nested_group_membership_enabled (pulumi.Input[bool]) – Nested group membership enable. Default false (bool)

  • port (pulumi.Input[float]) – OpenLdap port. Default 389 (int)

  • servers (pulumi.Input[list]) – OpenLdap servers list (list)

  • service_account_distinguished_name (pulumi.Input[str]) – Service account DN for access OpenLdap service (string)

  • service_account_password (pulumi.Input[str]) – Service account password for access OpenLdap service (string)

  • tls (pulumi.Input[bool]) – Enable TLS connection (bool)

  • type (pulumi.Input[str]) – (Computed) The type of the resource (string)

  • user_disabled_bit_mask (pulumi.Input[float]) – User disabled bit mask (int)

  • user_enabled_attribute (pulumi.Input[str]) – User enable attribute (string)

  • user_login_attribute (pulumi.Input[str]) – User login attribute. Default uid (string)

  • user_member_attribute (pulumi.Input[str]) – User member attribute. Default memberOf (string)

  • user_name_attribute (pulumi.Input[str]) – User name attribute. Default givenName (string)

  • user_object_class (pulumi.Input[str]) – User object class. Default inetorgperson (string)

  • user_search_attribute (pulumi.Input[str]) – User search attribute. Default uid|sn|givenName (string)

  • user_search_base (pulumi.Input[str]) – User search base DN (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.AuthConfigPing(resource_name, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, display_name_field=None, enabled=None, groups_field=None, idp_metadata_content=None, labels=None, rancher_api_host=None, sp_cert=None, sp_key=None, uid_field=None, user_name_field=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • display_name_field (pulumi.Input[str]) – Ping display name field (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • groups_field (pulumi.Input[str]) – Ping group field (string)

  • idp_metadata_content (pulumi.Input[str]) – Ping IDP metadata content (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • rancher_api_host (pulumi.Input[str]) – Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

  • sp_cert (pulumi.Input[str]) – Ping SP cert (string)

  • sp_key (pulumi.Input[str]) – Ping SP key (string)

  • uid_field (pulumi.Input[str]) – Ping UID field (string)

  • user_name_field (pulumi.Input[str]) – Ping user name field (string)

access_mode = None

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

allowed_principal_ids = None

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

annotations = None

Annotations of the resource (map)

display_name_field = None

Ping display name field (string)

enabled = None

Enable auth config provider. Default true (bool)

groups_field = None

Ping group field (string)

idp_metadata_content = None

Ping IDP metadata content (string)

labels = None

Labels of the resource (map)

name = None

(Computed) The name of the resource (string)

rancher_api_host = None

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

sp_cert = None

Ping SP cert (string)

sp_key = None

Ping SP key (string)

type = None

(Computed) The type of the resource (string)

uid_field = None

Ping UID field (string)

user_name_field = None

Ping user name field (string)

static get(resource_name, id, opts=None, access_mode=None, allowed_principal_ids=None, annotations=None, display_name_field=None, enabled=None, groups_field=None, idp_metadata_content=None, labels=None, name=None, rancher_api_host=None, sp_cert=None, sp_key=None, type=None, uid_field=None, user_name_field=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_mode (pulumi.Input[str]) – Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

  • allowed_principal_ids (pulumi.Input[list]) – Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • display_name_field (pulumi.Input[str]) – Ping display name field (string)

  • enabled (pulumi.Input[bool]) – Enable auth config provider. Default true (bool)

  • groups_field (pulumi.Input[str]) – Ping group field (string)

  • idp_metadata_content (pulumi.Input[str]) – Ping IDP metadata content (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • name (pulumi.Input[str]) – (Computed) The name of the resource (string)

  • rancher_api_host (pulumi.Input[str]) – Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

  • sp_cert (pulumi.Input[str]) – Ping SP cert (string)

  • sp_key (pulumi.Input[str]) – Ping SP key (string)

  • type (pulumi.Input[str]) – (Computed) The type of the resource (string)

  • uid_field (pulumi.Input[str]) – Ping UID field (string)

  • user_name_field (pulumi.Input[str]) – Ping user name field (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.AwaitableGetAppResult(annotations=None, answers=None, catalog_name=None, description=None, external_id=None, labels=None, name=None, project_id=None, revision_id=None, target_namespace=None, template_name=None, template_version=None, values_yaml=None, id=None)
class pulumi_rancher2.AwaitableGetCatalogResult(annotations=None, branch=None, cluster_id=None, description=None, kind=None, labels=None, name=None, password=None, project_id=None, scope=None, url=None, username=None, id=None)
class pulumi_rancher2.AwaitableGetCertificateResult(annotations=None, certs=None, description=None, labels=None, name=None, namespace_id=None, project_id=None, id=None)
class pulumi_rancher2.AwaitableGetCloudCredentialResult(annotations=None, labels=None, name=None, id=None)
class pulumi_rancher2.AwaitableGetClusterAlertGroupResult(annotations=None, cluster_id=None, description=None, group_interval_seconds=None, group_wait_seconds=None, labels=None, name=None, recipients=None, repeat_interval_seconds=None, id=None)
class pulumi_rancher2.AwaitableGetClusterAlterRuleResult(annotations=None, cluster_id=None, event_rule=None, group_id=None, group_interval_seconds=None, group_wait_seconds=None, inherited=None, labels=None, metric_rule=None, name=None, node_rule=None, repeat_interval_seconds=None, severity=None, system_service_rule=None, id=None)
class pulumi_rancher2.AwaitableGetClusterDriverResult(active=None, actual_url=None, annotations=None, builtin=None, checksum=None, labels=None, name=None, ui_url=None, url=None, whitelist_domains=None, id=None)
class pulumi_rancher2.AwaitableGetClusterLoggingResult(annotations=None, cluster_id=None, elasticsearch_config=None, fluentd_config=None, kafka_config=None, kind=None, labels=None, name=None, namespace_id=None, output_flush_interval=None, output_tags=None, splunk_config=None, syslog_config=None, id=None)
class pulumi_rancher2.AwaitableGetClusterResult(aks_config=None, annotations=None, cluster_auth_endpoint=None, cluster_monitoring_input=None, cluster_registration_token=None, cluster_template_answers=None, cluster_template_id=None, cluster_template_questions=None, cluster_template_revision_id=None, default_pod_security_policy_template_id=None, default_project_id=None, description=None, driver=None, eks_config=None, enable_cluster_alerting=None, enable_cluster_monitoring=None, enable_network_policy=None, gke_config=None, kube_config=None, labels=None, name=None, rke_config=None, system_project_id=None, id=None)
class pulumi_rancher2.AwaitableGetClusterRoleTemplateBindingResult(annotations=None, cluster_id=None, group_id=None, group_principal_id=None, labels=None, name=None, role_template_id=None, user_id=None, user_principal_id=None, id=None)
class pulumi_rancher2.AwaitableGetClusterTemplateResult(annotations=None, default_revision_id=None, description=None, labels=None, members=None, name=None, template_revisions=None, id=None)
class pulumi_rancher2.AwaitableGetEtcdBackupResult(annotations=None, backup_config=None, cluster_id=None, filename=None, labels=None, manual=None, name=None, namespace_id=None, id=None)
class pulumi_rancher2.AwaitableGetGlobalRoleBindingResult(annotations=None, global_role_id=None, labels=None, name=None, user_id=None, id=None)
class pulumi_rancher2.AwaitableGetMultiClusterAppResult(annotations=None, answers=None, catalog_name=None, labels=None, members=None, name=None, revision_history_limit=None, revision_id=None, roles=None, targets=None, template_name=None, template_version=None, template_version_id=None, upgrade_strategies=None, id=None)
class pulumi_rancher2.AwaitableGetNamespaceResult(annotations=None, container_resource_limit=None, description=None, labels=None, name=None, project_id=None, resource_quota=None, id=None)
class pulumi_rancher2.AwaitableGetNodeDriverResult(active=None, annotations=None, builtin=None, checksum=None, description=None, external_id=None, labels=None, name=None, ui_url=None, url=None, whitelist_domains=None, id=None)
class pulumi_rancher2.AwaitableGetNodePoolResult(annotations=None, cluster_id=None, control_plane=None, etcd=None, hostname_prefix=None, labels=None, name=None, node_template_id=None, quantity=None, worker=None, id=None)
class pulumi_rancher2.AwaitableGetNodeTemplateResult(annotations=None, cloud_credential_id=None, description=None, driver=None, engine_env=None, engine_insecure_registries=None, engine_install_url=None, engine_label=None, engine_opt=None, engine_registry_mirrors=None, engine_storage_driver=None, labels=None, name=None, use_internal_ip_address=None, id=None)
class pulumi_rancher2.AwaitableGetNotifierResult(annotations=None, cluster_id=None, description=None, labels=None, name=None, pagerduty_config=None, slack_config=None, smtp_config=None, webhook_config=None, wechat_config=None, id=None)
class pulumi_rancher2.AwaitableGetProjectAlertGroupResult(annotations=None, description=None, group_interval_seconds=None, group_wait_seconds=None, labels=None, name=None, project_id=None, recipients=None, repeat_interval_seconds=None, id=None)
class pulumi_rancher2.AwaitableGetProjectAlertRuleResult(annotations=None, group_id=None, group_interval_seconds=None, group_wait_seconds=None, inherited=None, labels=None, metric_rule=None, name=None, pod_rule=None, project_id=None, repeat_interval_seconds=None, severity=None, workload_rule=None, id=None)
class pulumi_rancher2.AwaitableGetProjectLoggingResult(annotations=None, elasticsearch_config=None, fluentd_config=None, kafka_config=None, kind=None, labels=None, name=None, namespace_id=None, output_flush_interval=None, output_tags=None, project_id=None, splunk_config=None, syslog_config=None, id=None)
class pulumi_rancher2.AwaitableGetProjectResult(annotations=None, cluster_id=None, container_resource_limit=None, description=None, enable_project_monitoring=None, labels=None, name=None, pod_security_policy_template_id=None, resource_quota=None, uuid=None, id=None)
class pulumi_rancher2.AwaitableGetProjectRoleTemplateBindingResult(annotations=None, group_id=None, group_principal_id=None, labels=None, name=None, project_id=None, role_template_id=None, user_id=None, user_principal_id=None, id=None)
class pulumi_rancher2.AwaitableGetRegistryResult(annotations=None, description=None, labels=None, name=None, namespace_id=None, project_id=None, registries=None, id=None)
class pulumi_rancher2.AwaitableGetRoleTempalteResult(administrative=None, annotations=None, builtin=None, context=None, default_role=None, description=None, external=None, hidden=None, labels=None, locked=None, name=None, role_template_ids=None, rules=None, id=None)
class pulumi_rancher2.AwaitableGetSecretResult(annotations=None, data=None, description=None, labels=None, name=None, namespace_id=None, project_id=None, id=None)
class pulumi_rancher2.AwaitableGetSettingResult(name=None, value=None, id=None)
class pulumi_rancher2.AwaitableGetUserResult(annotations=None, enabled=None, labels=None, name=None, principal_ids=None, username=None, id=None)
class pulumi_rancher2.Bootstrap(resource_name, opts=None, current_password=None, password=None, telemetry=None, token_ttl=None, token_update=None, __props__=None, __name__=None, __opts__=None)

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

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • current_password (pulumi.Input[str]) – Current password for Admin user. Just needed for recover if admin password has been changed from other resources and token is expired (string)

  • password (pulumi.Input[str]) – Password for Admin user or random generated if empty (string)

  • telemetry (pulumi.Input[bool]) – Send telemetry anonymous data. Default: false (bool)

  • token_ttl (pulumi.Input[float]) – TTL in seconds for generated admin token. Default: 0 (int)

  • token_update (pulumi.Input[bool]) – Regenerate admin token. Default: false (bool)

current_password = None

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

password = None

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

telemetry = None

Send telemetry anonymous data. Default: false (bool)

temp_token = None

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

temp_token_id = None

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

token = None

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

token_id = None

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

token_ttl = None

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

token_update = None

Regenerate admin token. Default: false (bool)

url = None

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

user = None

(Computed) Admin username (string)

static get(resource_name, id, opts=None, current_password=None, password=None, telemetry=None, temp_token=None, temp_token_id=None, token=None, token_id=None, token_ttl=None, token_update=None, url=None, user=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • current_password (pulumi.Input[str]) – Current password for Admin user. Just needed for recover if admin password has been changed from other resources and token is expired (string)

  • password (pulumi.Input[str]) – Password for Admin user or random generated if empty (string)

  • telemetry (pulumi.Input[bool]) – Send telemetry anonymous data. Default: false (bool)

  • temp_token (pulumi.Input[str]) – (Computed) Generated API temporary token as helper. Should be empty (string)

  • temp_token_id (pulumi.Input[str]) – (Computed) Generated API temporary token id as helper. Should be empty (string)

  • token (pulumi.Input[str]) – (Computed) Generated API token for Admin User (string)

  • token_id (pulumi.Input[str]) – (Computed) Generated API token id for Admin User (string)

  • token_ttl (pulumi.Input[float]) – TTL in seconds for generated admin token. Default: 0 (int)

  • token_update (pulumi.Input[bool]) – Regenerate admin token. Default: false (bool)

  • url (pulumi.Input[str]) – (Computed) URL set as server-url (string)

  • user (pulumi.Input[str]) – (Computed) Admin username (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.Catalog(resource_name, opts=None, annotations=None, branch=None, cluster_id=None, description=None, kind=None, labels=None, name=None, password=None, project_id=None, scope=None, url=None, username=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for the catalog (map)

  • branch (pulumi.Input[str]) – The branch of the catalog repo to use. Default master (string)

  • cluster_id (pulumi.Input[str]) – The cluster id of the catalog. Mandatory if scope = cluster (string)

  • description (pulumi.Input[str]) – A catalog description (string)

  • kind (pulumi.Input[str]) – The kind of the catalog. Just helm by the moment (string)

  • labels (pulumi.Input[dict]) – Labels for the catalog (map)

  • name (pulumi.Input[str]) – The name of the catalog (string)

  • password (pulumi.Input[str]) – The password to access the catalog if needed (string)

  • project_id (pulumi.Input[str]) – The project id of the catalog. Mandatory if scope = project (string)

  • scope (pulumi.Input[str]) – The scope of the catalog. cluster, global, and project are supported. Default global (string)

  • url (pulumi.Input[str]) – The url of the catalog repo (string)

  • username (pulumi.Input[str]) – The username to access the catalog if needed (string)

annotations = None

Annotations for the catalog (map)

branch = None

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

cluster_id = None

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

description = None

A catalog description (string)

kind = None

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

labels = None

Labels for the catalog (map)

name = None

The name of the catalog (string)

password = None

The password to access the catalog if needed (string)

project_id = None

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

scope = None

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

url = None

The url of the catalog repo (string)

username = None

The username to access the catalog if needed (string)

static get(resource_name, id, opts=None, annotations=None, branch=None, cluster_id=None, description=None, kind=None, labels=None, name=None, password=None, project_id=None, scope=None, url=None, username=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for the catalog (map)

  • branch (pulumi.Input[str]) – The branch of the catalog repo to use. Default master (string)

  • cluster_id (pulumi.Input[str]) – The cluster id of the catalog. Mandatory if scope = cluster (string)

  • description (pulumi.Input[str]) – A catalog description (string)

  • kind (pulumi.Input[str]) – The kind of the catalog. Just helm by the moment (string)

  • labels (pulumi.Input[dict]) – Labels for the catalog (map)

  • name (pulumi.Input[str]) – The name of the catalog (string)

  • password (pulumi.Input[str]) – The password to access the catalog if needed (string)

  • project_id (pulumi.Input[str]) – The project id of the catalog. Mandatory if scope = project (string)

  • scope (pulumi.Input[str]) – The scope of the catalog. cluster, global, and project are supported. Default global (string)

  • url (pulumi.Input[str]) – The url of the catalog repo (string)

  • username (pulumi.Input[str]) – The username to access the catalog if needed (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.Certificate(resource_name, opts=None, annotations=None, certs=None, description=None, key=None, labels=None, name=None, namespace_id=None, project_id=None, __props__=None, __name__=None, __opts__=None)

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 project_id

  • Namespaced certificate: Available to just namespace_id in the project_id

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for certificate object (map)

  • certs (pulumi.Input[str]) – Base64 encoded public certs (string)

  • description (pulumi.Input[str]) – A certificate description (string)

  • key (pulumi.Input[str]) – Base64 encoded private key (string)

  • labels (pulumi.Input[dict]) – Labels for certificate object (map)

  • name (pulumi.Input[str]) – The name of the certificate (string)

  • namespace_id (pulumi.Input[str]) – The namespace id where the namespaced certificate should be created (string)

  • project_id (pulumi.Input[str]) – The project id where the certificate should be created (string)

annotations = None

Annotations for certificate object (map)

certs = None

Base64 encoded public certs (string)

description = None

A certificate description (string)

key = None

Base64 encoded private key (string)

labels = None

Labels for certificate object (map)

name = None

The name of the certificate (string)

namespace_id = None

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

project_id = None

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

static get(resource_name, id, opts=None, annotations=None, certs=None, description=None, key=None, labels=None, name=None, namespace_id=None, project_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for certificate object (map)

  • certs (pulumi.Input[str]) – Base64 encoded public certs (string)

  • description (pulumi.Input[str]) – A certificate description (string)

  • key (pulumi.Input[str]) – Base64 encoded private key (string)

  • labels (pulumi.Input[dict]) – Labels for certificate object (map)

  • name (pulumi.Input[str]) – The name of the certificate (string)

  • namespace_id (pulumi.Input[str]) – The namespace id where the namespaced certificate should be created (string)

  • project_id (pulumi.Input[str]) – The project id where the certificate should be created (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.CloudCredential(resource_name, opts=None, amazonec2_credential_config=None, annotations=None, azure_credential_config=None, description=None, digitalocean_credential_config=None, labels=None, name=None, openstack_credential_config=None, vsphere_credential_config=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • amazonec2_credential_config (pulumi.Input[dict]) – AWS config for the Cloud Credential (list maxitems:1)

  • annotations (pulumi.Input[dict]) – Annotations for Cloud Credential object (map)

  • azure_credential_config (pulumi.Input[dict]) – Azure config for the Cloud Credential (list maxitems:1)

  • description (pulumi.Input[str]) – Description for the Cloud Credential (string)

  • digitalocean_credential_config (pulumi.Input[dict]) – DigitalOcean config for the Cloud Credential (list maxitems:1)

  • labels (pulumi.Input[dict]) – Labels for Cloud Credential object (map)

  • name (pulumi.Input[str]) – The name of the Cloud Credential (string)

  • openstack_credential_config (pulumi.Input[dict]) – OpenStack config for the Cloud Credential (list maxitems:1)

  • vsphere_credential_config (pulumi.Input[dict]) – vSphere config for the Cloud Credential (list maxitems:1)

The amazonec2_credential_config object supports the following:

  • access_key (pulumi.Input[str]) - AWS access key (string)

  • secret_key (pulumi.Input[str]) - AWS secret key (string)

The azure_credential_config object supports the following:

  • client_id (pulumi.Input[str]) - Azure Service Principal Account ID (string)

  • client_secret (pulumi.Input[str]) - Azure Service Principal Account password (string)

  • subscriptionId (pulumi.Input[str]) - Azure Subscription ID (string)

The digitalocean_credential_config object supports the following:

  • accessToken (pulumi.Input[str]) - DigitalOcean access token (string)

The openstack_credential_config object supports the following:

  • password (pulumi.Input[str]) - vSphere password (string)

The vsphere_credential_config object supports the following:

  • password (pulumi.Input[str]) - vSphere password (string)

  • username (pulumi.Input[str]) - vSphere username (string)

  • vcenter (pulumi.Input[str]) - vSphere IP/hostname for vCenter (string)

  • vcenterPort (pulumi.Input[str]) - vSphere Port for vCenter. Default 443 (string)

amazonec2_credential_config = None

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

  • access_key (str) - AWS access key (string)

  • secret_key (str) - AWS secret key (string)

annotations = None

Annotations for Cloud Credential object (map)

azure_credential_config = None

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

  • client_id (str) - Azure Service Principal Account ID (string)

  • client_secret (str) - Azure Service Principal Account password (string)

  • subscriptionId (str) - Azure Subscription ID (string)

description = None

Description for the Cloud Credential (string)

digitalocean_credential_config = None

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

  • accessToken (str) - DigitalOcean access token (string)

driver = None

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

labels = None

Labels for Cloud Credential object (map)

name = None

The name of the Cloud Credential (string)

openstack_credential_config = None

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

  • password (str) - vSphere password (string)

vsphere_credential_config = None

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

  • password (str) - vSphere password (string)

  • username (str) - vSphere username (string)

  • vcenter (str) - vSphere IP/hostname for vCenter (string)

  • vcenterPort (str) - vSphere Port for vCenter. Default 443 (string)

static get(resource_name, id, opts=None, amazonec2_credential_config=None, annotations=None, azure_credential_config=None, description=None, digitalocean_credential_config=None, driver=None, labels=None, name=None, openstack_credential_config=None, vsphere_credential_config=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • amazonec2_credential_config (pulumi.Input[dict]) – AWS config for the Cloud Credential (list maxitems:1)

  • annotations (pulumi.Input[dict]) – Annotations for Cloud Credential object (map)

  • azure_credential_config (pulumi.Input[dict]) – Azure config for the Cloud Credential (list maxitems:1)

  • description (pulumi.Input[str]) – Description for the Cloud Credential (string)

  • digitalocean_credential_config (pulumi.Input[dict]) – DigitalOcean config for the Cloud Credential (list maxitems:1)

  • driver (pulumi.Input[str]) – (Computed) The driver of the Cloud Credential (string)

  • labels (pulumi.Input[dict]) – Labels for Cloud Credential object (map)

  • name (pulumi.Input[str]) – The name of the Cloud Credential (string)

  • openstack_credential_config (pulumi.Input[dict]) – OpenStack config for the Cloud Credential (list maxitems:1)

  • vsphere_credential_config (pulumi.Input[dict]) – vSphere config for the Cloud Credential (list maxitems:1)

The amazonec2_credential_config object supports the following:

  • access_key (pulumi.Input[str]) - AWS access key (string)

  • secret_key (pulumi.Input[str]) - AWS secret key (string)

The azure_credential_config object supports the following:

  • client_id (pulumi.Input[str]) - Azure Service Principal Account ID (string)

  • client_secret (pulumi.Input[str]) - Azure Service Principal Account password (string)

  • subscriptionId (pulumi.Input[str]) - Azure Subscription ID (string)

The digitalocean_credential_config object supports the following:

  • accessToken (pulumi.Input[str]) - DigitalOcean access token (string)

The openstack_credential_config object supports the following:

  • password (pulumi.Input[str]) - vSphere password (string)

The vsphere_credential_config object supports the following:

  • password (pulumi.Input[str]) - vSphere password (string)

  • username (pulumi.Input[str]) - vSphere username (string)

  • vcenter (pulumi.Input[str]) - vSphere IP/hostname for vCenter (string)

  • vcenterPort (pulumi.Input[str]) - vSphere Port for vCenter. Default 443 (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.Cluster(resource_name, opts=None, aks_config=None, annotations=None, cluster_auth_endpoint=None, cluster_monitoring_input=None, cluster_template_answers=None, cluster_template_id=None, cluster_template_questions=None, cluster_template_revision_id=None, default_pod_security_policy_template_id=None, description=None, desired_agent_image=None, desired_auth_image=None, docker_root_dir=None, driver=None, eks_config=None, enable_cluster_alerting=None, enable_cluster_istio=None, enable_cluster_monitoring=None, enable_network_policy=None, gke_config=None, labels=None, name=None, rke_config=None, __props__=None, __name__=None, __opts__=None)

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

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • aks_config (pulumi.Input[dict]) – The Azure AKS configuration for aks Clusters. Conflicts with eks_config, gke_config and rke_config (list maxitems:1)

  • annotations (pulumi.Input[dict]) – Annotations for cluster registration token object (map)

  • cluster_auth_endpoint (pulumi.Input[dict]) – Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

  • cluster_monitoring_input (pulumi.Input[dict]) – Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)

  • cluster_template_answers (pulumi.Input[dict]) – Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)

  • cluster_template_id (pulumi.Input[str]) – Cluster template ID. Just for Rancher v2.3.x and above (string)

  • cluster_template_questions (pulumi.Input[list]) – Cluster template questions. Just for Rancher v2.3.x and above (list)

  • cluster_template_revision_id (pulumi.Input[str]) – Cluster template revision ID. Just for Rancher v2.3.x and above (string)

  • default_pod_security_policy_template_id (pulumi.Input[str]) – Default pod security policy template id (string)

  • description (pulumi.Input[str]) – An optional description of this cluster (string)

  • desired_agent_image (pulumi.Input[str]) – Desired agent image. Just for Rancher v2.3.x and above (string)

  • desired_auth_image (pulumi.Input[str]) – Desired auth image. Just for Rancher v2.3.x and above (string)

  • docker_root_dir (pulumi.Input[str]) – Desired auth image. Just for Rancher v2.3.x and above (string)

  • driver (pulumi.Input[str]) – (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)

  • eks_config (pulumi.Input[dict]) – The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, gke_config and rke_config (list maxitems:1)

  • enable_cluster_alerting (pulumi.Input[bool]) – Enable built-in cluster alerting. Default false (bool)

  • enable_cluster_istio (pulumi.Input[bool]) – Enable built-in cluster istio. Default false. Just for Rancher v2.3.x and above (bool)

  • enable_cluster_monitoring (pulumi.Input[bool]) – Enable built-in cluster monitoring. Default false (bool)

  • enable_network_policy (pulumi.Input[bool]) – Enable project network isolation. Default false (bool)

  • gke_config (pulumi.Input[dict]) – The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config and rke_config (list maxitems:1)

  • labels (pulumi.Input[dict]) – Labels for cluster registration token object (map)

  • name (pulumi.Input[str]) – Name of cluster registration token (string)

  • rke_config (pulumi.Input[dict]) – The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config and gke_config (list maxitems:1)

The aks_config object supports the following:

  • aadServerAppSecret (pulumi.Input[str]) - The secret of an Azure Active Directory server application (string)

  • aadTenantId (pulumi.Input[str]) - The ID of an Azure Active Directory tenant (string)

  • addClientAppId (pulumi.Input[str]) - The ID of an Azure Active Directory client application of type “Native”. This application is for user login via kubectl (string)

  • addServerAppId (pulumi.Input[str]) - The ID of an Azure Active Directory server application of type “Web app/API”. This application represents the managed cluster’s apiserver (Server application) (string)

  • adminUsername (pulumi.Input[str]) - The administrator username to use for Linux hosts. Default azureuser (string)

  • agentDnsPrefix (pulumi.Input[str]) - DNS prefix to be used to create the FQDN for the agent pool (string)

  • agentOsDiskSize (pulumi.Input[float]) - GB size to be used to specify the disk for every machine in the agent pool. If you specify 0, it will apply the default according to the “agent vm size” specified. Default 0 (int)

  • agentPoolName (pulumi.Input[str]) - Name for the agent pool, upto 12 alphanumeric characters. Default agentpool0 (string)

  • agentStorageProfile (pulumi.Input[str]) - Storage profile specifies what kind of storage used on machine in the agent pool. Chooses from [ManagedDisks StorageAccount]. Default ManagedDisks (string)

  • agentVmSize (pulumi.Input[str]) - Size of machine in the agent pool. Default Standard_D1_v2 (string)

  • authBaseUrl (pulumi.Input[str]) - Different authentication API url to use. Default https://login.microsoftonline.com/ (string)

  • baseUrl (pulumi.Input[str]) - Different resource management API url to use. Default https://management.azure.com/ (string)

  • client_id (pulumi.Input[str]) - Azure client ID to use (string)

  • client_secret (pulumi.Input[str]) - Azure client secret associated with the “client id” (string)

  • count (pulumi.Input[float]) - Number of machines (VMs) in the agent pool. Allowed values must be in the range of 1 to 100 (inclusive). Default 1 (int)

  • dnsServiceIp (pulumi.Input[str]) - An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes Service address range specified in “service cidr”. Default 10.0.0.10 (string)

  • dockerBridgeCidr (pulumi.Input[str]) - A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes Service address range specified in “service cidr”. Default 172.17.0.1/16 (string)

  • enableHttpApplicationRouting (pulumi.Input[bool]) - Enable the Kubernetes ingress with automatic public DNS name creation. Default false (bool)

  • enableMonitoring (pulumi.Input[bool]) - Turn on Azure Log Analytics monitoring. Uses the Log Analytics “Default” workspace if it exists, else creates one. if using an existing workspace, specifies “log analytics workspace resource id”. Default true (bool)

  • kubernetesVersion (pulumi.Input[str]) - The Kubernetes master version (string)

  • location (pulumi.Input[str]) - Azure Kubernetes cluster location. Default eastus (string)

  • logAnalyticsWorkspace (pulumi.Input[str]) - The name of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses ‘{resource group}-{subscription id}-{location code}’ (string)

  • logAnalyticsWorkspaceResourceGroup (pulumi.Input[str]) - The resource group of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses the ‘Cluster’ resource group (string)

  • masterDnsPrefix (pulumi.Input[str]) - DNS prefix to use the Kubernetes cluster control pane (string)

  • maxPods (pulumi.Input[float]) - Maximum number of pods that can run on a node. Default 110 (int)

  • networkPlugin (pulumi.Input[str]) - Network plugin used for building Kubernetes network. Chooses from azure or kubenet. Default azure (string)

  • networkPolicy (pulumi.Input[str]) - Network policy used for building Kubernetes network. Chooses from calico (string)

  • podCidr (pulumi.Input[str]) - A CIDR notation IP range from which to assign Kubernetes Pod IPs when “network plugin” is specified in “kubenet”. Default 172.244.0.0/16 (string)

  • resourceGroup (pulumi.Input[str]) - The name of the Cluster resource group (string)

  • serviceCidr (pulumi.Input[str]) - A CIDR notation IP range from which to assign Kubernetes Service cluster IPs. It must not overlap with any Subnet IP ranges. Default 10.0.0.0/16 (string)

  • sshPublicKeyContents (pulumi.Input[str]) - Contents of the SSH public key used to authenticate with Linux hosts (string)

  • subnet (pulumi.Input[str]) - The name of an existing Azure Virtual Subnet. Composite of agent virtual network subnet ID (string)

  • subscriptionId (pulumi.Input[str]) - Subscription credentials which uniquely identify Microsoft Azure subscription (string)

  • tag (pulumi.Input[dict]) - Tags for Kubernetes cluster. For example, foo=bar (map)

  • tenant_id (pulumi.Input[str]) - Azure tenant ID to use (string)

  • virtualNetwork (pulumi.Input[str]) - The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

  • virtualNetworkResourceGroup (pulumi.Input[str]) - The resource group of an existing Azure Virtual Network. Composite of agent virtual network subnet ID (string)

The cluster_auth_endpoint object supports the following:

  • ca_certs (pulumi.Input[str]) - CA certs for the authorized cluster endpoint (string)

  • enabled (pulumi.Input[bool]) - Enable the authorized cluster endpoint. Default true (bool)

  • fqdn (pulumi.Input[str]) - FQDN for the authorized cluster endpoint (string)

The cluster_monitoring_input object supports the following:

  • answers (pulumi.Input[dict]) - Key/value answers for monitor input (map)

The cluster_template_answers object supports the following:

  • cluster_id (pulumi.Input[str]) - Cluster ID (string)

  • project_id (pulumi.Input[str]) - Project ID to apply answer (string)

  • values (pulumi.Input[dict]) - Key/values for answer (map)

The cluster_template_questions object supports the following:

  • default (pulumi.Input[str]) - Default variable value (string)

  • required (pulumi.Input[bool]) - Required variable. Default false (bool)

  • type (pulumi.Input[str]) - Variable type. boolean, int and string are allowed. Default string (string)

  • variable (pulumi.Input[str]) - Variable name (string) ..

    > c6a2cbc… Feat: added .ClusterTemplate datasource and resource. For rancher V2.3.x. Doc files

The eks_config object supports the following:

  • access_key (pulumi.Input[str]) - The AWS Client ID to use (string)

  • ami (pulumi.Input[str]) - AMI ID to use for the worker nodes instead of the default (string)

  • associateWorkerNodePublicIp (pulumi.Input[bool]) - Associate public ip EKS worker nodes. Default true (bool)

  • desiredNodes (pulumi.Input[float]) - The desired number of worker nodes. Just for Rancher v2.3.x and above. Default 3 (int)

  • instanceType (pulumi.Input[str]) - The type of machine to use for worker nodes. Default t2.medium (string)

  • keyPairName (pulumi.Input[str]) - Allow user to specify key name to use. Just for Rancher v2.2.7 and above (string)

  • kubernetesVersion (pulumi.Input[str]) - The Kubernetes master version (string)

  • maximumNodes (pulumi.Input[float]) - The maximum number of worker nodes. Default 3 (int)

  • minimumNodes (pulumi.Input[float]) - The minimum number of worker nodes. Default 1 (int)

  • nodeVolumeSize (pulumi.Input[float]) - The volume size for each node. Default 20 (int)

  • region (pulumi.Input[str]) - The AWS Region to create the EKS cluster in. Default us-west-2 (string)

  • secret_key (pulumi.Input[str]) - The AWS Client Secret associated with the Client ID (string)

  • securityGroups (pulumi.Input[list]) - List of security groups to use for the cluster. If it’s not specified Rancher will create a new security group (list)

  • serviceRole (pulumi.Input[str]) - The service role to use to perform the cluster operations in AWS. If it’s not specified Rancher will create a new service role (string)

  • sessionToken (pulumi.Input[str]) - A session token to use with the client key and secret if applicable (string)

  • subnets (pulumi.Input[list]) - List of subnets in the virtual network to use. If it’s not specified Rancher will create 3 news subnets (list)

  • userData (pulumi.Input[str]) - Pass user-data to the nodes to perform automated configuration tasks (string)

  • virtualNetwork (pulumi.Input[str]) - The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

The gke_config object supports the following:

  • clusterIpv4Cidr (pulumi.Input[str]) - The IP address range of the container pods (string)

  • credential (pulumi.Input[str]) - The contents of the GC credential file (string)

  • description (pulumi.Input[str]) - An optional description of this cluster (string)

  • diskSizeGb (pulumi.Input[float]) - Size of the disk attached to each node. Default 100 (int)

  • diskType (pulumi.Input[str]) - Type of the disk attached to each node (string)

  • enableAlphaFeature (pulumi.Input[bool]) - To enable Kubernetes alpha feature. Default true (bool)

  • enableAutoRepair (pulumi.Input[bool]) - Specifies whether the node auto-repair is enabled for the node pool. Default false (bool)

  • enableAutoUpgrade (pulumi.Input[bool]) - Specifies whether node auto-upgrade is enabled for the node pool. Default false (bool)

  • enableHorizontalPodAutoscaling (pulumi.Input[bool]) - Enable horizontal pod autoscaling for the cluster. Default true (bool)

  • enableHttpLoadBalancing (pulumi.Input[bool]) - Enable HTTP load balancing on GKE cluster. Default true (bool)

  • enableKubernetesDashboard (pulumi.Input[bool]) - Whether to enable the Kubernetes dashboard. Default false (bool)

  • enableLegacyAbac (pulumi.Input[bool]) - Whether to enable legacy abac on the cluster. Default false (bool)

  • enableMasterAuthorizedNetwork (pulumi.Input[bool])

  • enableNetworkPolicyConfig (pulumi.Input[bool]) - Enable stackdriver logging. Default true (bool)

  • enableNodepoolAutoscaling (pulumi.Input[bool]) - Enable nodepool autoscaling. Default false (bool)

  • enablePrivateEndpoint (pulumi.Input[bool]) - Whether the master’s internal IP address is used as the cluster endpoint. Default false (bool)

  • enablePrivateNodes (pulumi.Input[bool]) - Whether nodes have internal IP address only. Default false (bool)

  • enableStackdriverLogging (pulumi.Input[bool]) - Enable stackdriver monitoring. Default true (bool)

  • enableStackdriverMonitoring (pulumi.Input[bool]) - Enable stackdriver monitoring on GKE cluster (bool)

  • imageType (pulumi.Input[str]) - The image to use for the worker nodes (string)

  • ipPolicyClusterIpv4CidrBlock (pulumi.Input[str]) - The IP address range for the cluster pod IPs (string)

  • ipPolicyClusterSecondaryRangeName (pulumi.Input[str]) - The name of the secondary range to be used for the cluster CIDR block (string)

  • ipPolicyCreateSubnetwork (pulumi.Input[bool]) - Whether a new subnetwork will be created automatically for the cluster. Default false (bool)

  • ipPolicyNodeIpv4CidrBlock (pulumi.Input[str]) - The IP address range of the instance IPs in this cluster (string)

  • ipPolicyServicesIpv4CidrBlock (pulumi.Input[str]) - The IP address range of the services IPs in this cluster (string)

  • ipPolicyServicesSecondaryRangeName (pulumi.Input[str]) - The name of the secondary range to be used for the services CIDR block (string)

  • ipPolicySubnetworkName (pulumi.Input[str]) - A custom subnetwork name to be used if createSubnetwork is true (string)

  • issueClientCertificate (pulumi.Input[bool]) - Issue a client certificate. Default false (bool)

  • kubernetesDashboard (pulumi.Input[bool]) - Enable the Kubernetes dashboard. Default false (bool)

  • labels (pulumi.Input[dict]) - Labels for cluster registration token object (map)

  • localSsdCount (pulumi.Input[float]) - The number of local SSD disks to be attached to the node. Default 0 (int)

  • locations (pulumi.Input[list]) - Locations for GKE cluster (list)

  • machineType (pulumi.Input[str]) - Machine type for GKE cluster (string)

  • maintenanceWindow (pulumi.Input[str]) - Maintenance window for GKE cluster (string)

  • masterAuthorizedNetworkCidrBlocks (pulumi.Input[list]) - Define up to 10 external networks that could access Kubernetes master through HTTPS (list)

  • masterIpv4CidrBlock (pulumi.Input[str]) - The IP range in CIDR notation to use for the hosted master network (string)

  • masterVersion (pulumi.Input[str]) - Master version for GKE cluster (string)

  • maxNodeCount (pulumi.Input[float]) - Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. Default 0 (int)

  • minNodeCount (pulumi.Input[float]) - Minimmum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. Default 0 (int)

  • network (pulumi.Input[str]) - Network for GKE cluster (string)

  • nodeCount (pulumi.Input[float]) - Node count for GKE cluster. Default 3 (int)

  • nodePool (pulumi.Input[str]) - The ID of the cluster node pool (string)

  • nodeVersion (pulumi.Input[str]) - Node version for GKE cluster (string)

  • oauthScopes (pulumi.Input[list]) - The set of Google API scopes to be made available on all of the node VMs under the default service account (list)

  • preemptible (pulumi.Input[bool]) - Whether the nodes are created as preemptible VM instances. Default false (bool)

  • project_id (pulumi.Input[str]) - Project ID to apply answer (string)

  • resourceLabels (pulumi.Input[dict]) - The map of Kubernetes labels to be applied to each cluster (map)

  • serviceAccount (pulumi.Input[str]) - The Google Cloud Platform Service Account to be used by the node VMs (string)

  • subNetwork (pulumi.Input[str]) - Subnetwork for GKE cluster (string)

  • taints (pulumi.Input[list]) - List of Kubernetes taints to be applied to each node (list)

  • useIpAliases (pulumi.Input[bool]) - Whether alias IPs will be used for pod IPs in the cluster. Default false (bool)

  • zone (pulumi.Input[str]) - Zone GKE cluster (string)

The rke_config object supports the following:

  • addonJobTimeout (pulumi.Input[float]) - Duration in seconds of addon job (int)

  • addons (pulumi.Input[str]) - Addons descripton to deploy on RKE cluster.

  • addonsIncludes (pulumi.Input[list]) - Addons yaml manifests to deploy on RKE cluster (list)

  • authentication (pulumi.Input[dict]) - Kubernetes cluster authentication (list maxitems:1)

    • sans (pulumi.Input[list]) - RKE sans for authentication ([]string)

    • strategy (pulumi.Input[str]) - RKE strategy for authentication (string)

  • authorization (pulumi.Input[dict]) - Kubernetes cluster authorization (list maxitems:1)

    • mode (pulumi.Input[str]) - RKE mode for authorization. rbac and none modes are available. Default rbac (string)

    • options (pulumi.Input[dict]) - RKE options for network (map)

  • bastionHost (pulumi.Input[dict]) - RKE bastion host (list maxitems:1)

    • address (pulumi.Input[str]) - Address ip for node (string)

    • port (pulumi.Input[str]) - Port for node. Default 22 (string)

    • sshAgentAuth (pulumi.Input[bool]) - Use ssh agent auth. Default false (bool)

    • sshKey (pulumi.Input[str]) - Node SSH private key (string)

    • sshKeyPath (pulumi.Input[str]) - Node SSH private key path (string)

    • user (pulumi.Input[str]) - Registry user (string)

  • cloudProvider (pulumi.Input[dict]) - RKE options for Calico network provider (string)

    • awsCloudProvider (pulumi.Input[dict]) - RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)

      • global (pulumi.Input[dict]) - (list maxitems:1)

        • disableSecurityGroupIngress (pulumi.Input[bool]) - Default false (bool)

        • disableStrictZoneCheck (pulumi.Input[bool]) - Default false (bool)

        • elbSecurityGroup (pulumi.Input[str]) - (string)

        • kubernetesClusterId (pulumi.Input[str]) - (string)

        • kubernetesClusterTag (pulumi.Input[str]) - (string)

        • roleArn (pulumi.Input[str]) - (string)

        • routeTableId (pulumi.Input[str]) - (string)

        • subnetId (pulumi.Input[str]) - (string)

        • vpc (pulumi.Input[str]) - (string)

        • zone (pulumi.Input[str]) - Zone GKE cluster (string)

      • serviceOverrides (pulumi.Input[list]) - (list)

        • region (pulumi.Input[str]) - The AWS Region to create the EKS cluster in. Default us-west-2 (string)

        • service (pulumi.Input[str]) - (string)

        • signingMethod (pulumi.Input[str]) - (string)

        • signingName (pulumi.Input[str]) - (string)

        • signingRegion (pulumi.Input[str]) - (string)

        • url (pulumi.Input[str]) - Registry URL (string)

    • azureCloudProvider (pulumi.Input[dict]) - RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)

      • aadClientCertPassword (pulumi.Input[str]) - (string)

      • aadClientCertPath (pulumi.Input[str]) - (string)

      • aadClientId (pulumi.Input[str]) - (string)

      • aadClientSecret (pulumi.Input[str]) - (string)

      • cloud (pulumi.Input[str]) - (string)

      • cloudProviderBackoff (pulumi.Input[bool]) - (bool)

      • cloudProviderBackoffDuration (pulumi.Input[float]) - (int)

      • cloudProviderBackoffExponent (pulumi.Input[float]) - (int)

      • cloudProviderBackoffJitter (pulumi.Input[float]) - (int)

      • cloudProviderBackoffRetries (pulumi.Input[float]) - (int)

      • cloudProviderRateLimit (pulumi.Input[bool]) - (bool)

      • cloudProviderRateLimitBucket (pulumi.Input[float]) - (int)

      • cloudProviderRateLimitQps (pulumi.Input[float]) - (int)

      • location (pulumi.Input[str]) - Azure Kubernetes cluster location. Default eastus (string)

      • maximumLoadBalancerRuleCount (pulumi.Input[float]) - (int)

      • primaryAvailabilitySetName (pulumi.Input[str]) - (string)

      • primaryScaleSetName (pulumi.Input[str]) - (string)

      • resourceGroup (pulumi.Input[str]) - The name of the Cluster resource group (string)

      • routeTableName (pulumi.Input[str]) - (string)

      • securityGroupName (pulumi.Input[str]) - (string)

      • subnetName (pulumi.Input[str]) - (string)

      • subscriptionId (pulumi.Input[str]) - Subscription credentials which uniquely identify Microsoft Azure subscription (string)

      • tenant_id (pulumi.Input[str]) - Azure tenant ID to use (string)

      • useInstanceMetadata (pulumi.Input[bool]) - (bool)

      • useManagedIdentityExtension (pulumi.Input[bool]) - (bool)

      • vmType (pulumi.Input[str]) - (string)

      • vnetName (pulumi.Input[str]) - (string)

      • vnetResourceGroup (pulumi.Input[str]) - (string)

    • customCloudProvider (pulumi.Input[str]) - RKE Custom Cloud Provider config for Cloud Provider (string) (string)

    • name (pulumi.Input[str]) - Name of cluster registration token (string)

    • openstackCloudProvider (pulumi.Input[dict]) - RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)

      • blockStorage (pulumi.Input[dict]) - (list maxitems:1)

        • bsVersion (pulumi.Input[str]) - (string)

        • ignoreVolumeAz (pulumi.Input[bool]) - (string)

        • trustDevicePath (pulumi.Input[bool]) - (string)

      • global (pulumi.Input[dict]) - (list maxitems:1)

        • authUrl (pulumi.Input[str]) - (string)

        • caFile (pulumi.Input[str]) - (string)

        • domainId (pulumi.Input[str]) - Required if domain_name not provided. (string)

        • domainName (pulumi.Input[str]) - Required if domain_id not provided. (string)

        • password (pulumi.Input[str]) - Registry password (string)

        • region (pulumi.Input[str]) - The AWS Region to create the EKS cluster in. Default us-west-2 (string)

        • tenant_id (pulumi.Input[str]) - Azure tenant ID to use (string)

        • tenantName (pulumi.Input[str]) - Required if tenant_id not provided. (string)

        • trustId (pulumi.Input[str]) - (string)

        • username (pulumi.Input[str]) - (string)

      • loadBalancer (pulumi.Input[dict]) - (list maxitems:1)

        • createMonitor (pulumi.Input[bool]) - (bool)

        • floatingNetworkId (pulumi.Input[str]) - (string)

        • lbMethod (pulumi.Input[str]) - (string)

        • lbProvider (pulumi.Input[str]) - (string)

        • lbVersion (pulumi.Input[str]) - (string)

        • manageSecurityGroups (pulumi.Input[bool]) - (bool)

        • monitorDelay (pulumi.Input[str]) - Default 60s (string)

        • monitorMaxRetries (pulumi.Input[float]) - Default 5 (int)

        • monitorTimeout (pulumi.Input[str]) - Default 30s (string)

        • subnetId (pulumi.Input[str]) - (string)

        • useOctavia (pulumi.Input[bool]) - (bool)

      • metadata (pulumi.Input[dict]) - (list maxitems:1)

        • requestTimeout (pulumi.Input[float]) - (int)

        • searchOrder (pulumi.Input[str]) - (string)

      • route (pulumi.Input[dict]) - (list maxitems:1)

        • routerId (pulumi.Input[str]) - (string)

    • vsphereCloudProvider (pulumi.Input[dict]) - RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument name is required on virtual_center configuration. (list maxitems:1)

      • disk (pulumi.Input[dict]) - (list maxitems:1)

        • scsiControllerType (pulumi.Input[str]) - (string)

      • global (pulumi.Input[dict]) - (list maxitems:1)

        • datacenters (pulumi.Input[str]) - (string)

        • insecureFlag (pulumi.Input[bool]) - (bool)

        • password (pulumi.Input[str]) - Registry password (string)

        • port (pulumi.Input[str]) - Port for node. Default 22 (string)

        • soapRoundtripCount (pulumi.Input[float]) - (int)

        • user (pulumi.Input[str]) - Registry user (string)

      • network (pulumi.Input[dict]) - Network for GKE cluster (string)

        • publicNetwork (pulumi.Input[str]) - (string)

      • virtualCenters (pulumi.Input[list]) - (List)

        • datacenters (pulumi.Input[str]) - (string)

        • name (pulumi.Input[str]) - Name of cluster registration token (string)

        • password (pulumi.Input[str]) - Registry password (string)

        • port (pulumi.Input[str]) - Port for node. Default 22 (string)

        • soapRoundtripCount (pulumi.Input[float]) - (int)

        • user (pulumi.Input[str]) - Registry user (string)

      • workspace (pulumi.Input[dict]) - (list maxitems:1)

        • datacenter (pulumi.Input[str]) - (string)

        • defaultDatastore (pulumi.Input[str]) - (string)

        • folder (pulumi.Input[str]) - Folder for S3 service. Available from Rancher v2.2.7 (string)

        • resourcepoolPath (pulumi.Input[str]) - (string)

        • server (pulumi.Input[str]) - (string)

  • dns (pulumi.Input[dict]) - RKE dns add-on. Just for Rancher v2.2.x (list maxitems:1)

    • nodeSelector (pulumi.Input[dict]) - Node selector for RKE Ingress (map)

    • provider (pulumi.Input[str]) - Provider for RKE monitoring (string)

    • reverseCidrs (pulumi.Input[list]) - DNS add-on reverse cidr (list)

    • upstreamNameservers (pulumi.Input[list]) - DNS add-on upstream nameservers (list)

  • ignoreDockerVersion (pulumi.Input[bool]) - Ignore docker version. Default true (bool)

  • ingress (pulumi.Input[dict]) - Kubernetes ingress configuration (list maxitems:1)

    • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

    • nodeSelector (pulumi.Input[dict]) - Node selector for RKE Ingress (map)

    • options (pulumi.Input[dict]) - RKE options for network (map)

    • provider (pulumi.Input[str]) - Provider for RKE monitoring (string)

  • kubernetesVersion (pulumi.Input[str]) - The Kubernetes master version (string)

  • monitoring (pulumi.Input[dict]) - Kubernetes cluster monitoring (list maxitems:1)

    • options (pulumi.Input[dict]) - RKE options for network (map)

    • provider (pulumi.Input[str]) - Provider for RKE monitoring (string)

  • network (pulumi.Input[dict]) - Network for GKE cluster (string)

    • calicoNetworkProvider (pulumi.Input[dict]) - Calico provider config for RKE network (list maxitems:1)

      • cloudProvider (pulumi.Input[str]) - RKE options for Calico network provider (string)

    • canalNetworkProvider (pulumi.Input[dict]) - Canal provider config for RKE network (list maxitems:1)

      • iface (pulumi.Input[str]) - Iface config Flannel network provider (string)

    • flannelNetworkProvider (pulumi.Input[dict]) - Flannel provider config for RKE network (list maxitems:1)

      • iface (pulumi.Input[str]) - Iface config Flannel network provider (string)

    • options (pulumi.Input[dict]) - RKE options for network (map)

    • plugin (pulumi.Input[str]) - Plugin for RKE network. canal (default), flannel, calico and weave are supported. (string)

    • weaveNetworkProvider (pulumi.Input[dict]) - Weave provider config for RKE network (list maxitems:1)

      • password (pulumi.Input[str]) - Registry password (string)

  • nodes (pulumi.Input[list]) - RKE cluster nodes (list)

    • address (pulumi.Input[str]) - Address ip for node (string)

    • dockerSocket (pulumi.Input[str]) - Docker socket for node (string)

    • hostnameOverride (pulumi.Input[str]) - Hostname override for node (string)

    • internalAddress (pulumi.Input[str]) - Internal ip for node (string)

    • labels (pulumi.Input[dict]) - Labels for cluster registration token object (map)

    • nodeId (pulumi.Input[str]) - Id for the node (string)

    • port (pulumi.Input[str]) - Port for node. Default 22 (string)

    • roles (pulumi.Input[list]) - Roles for the node. controlplane, etcd and worker are supported. (list)

    • sshAgentAuth (pulumi.Input[bool]) - Use ssh agent auth. Default false (bool)

    • sshKey (pulumi.Input[str]) - Node SSH private key (string)

    • sshKeyPath (pulumi.Input[str]) - Node SSH private key path (string)

    • user (pulumi.Input[str]) - Registry user (string)

  • prefixPath (pulumi.Input[str]) - Prefix to customize Kubernetes path (string)

  • privateRegistries (pulumi.Input[list]) - private registries for docker images (list)

    • isDefault (pulumi.Input[bool]) - Set as default registry. Default false (bool)

    • password (pulumi.Input[str]) - Registry password (string)

    • url (pulumi.Input[str]) - Registry URL (string)

    • user (pulumi.Input[str]) - Registry user (string)

  • services (pulumi.Input[dict]) - Kubernetes cluster services (list maxitems:1)

    • etcd (pulumi.Input[dict]) - Etcd options for RKE services (list maxitems:1)

      • backup_config (pulumi.Input[dict]) - Backup options for etcd service. Just for Rancher v2.2.x (list maxitems:1)

        • enabled (pulumi.Input[bool]) - Enable the authorized cluster endpoint. Default true (bool)

        • intervalHours (pulumi.Input[float]) - Interval hours for etcd backup. Default 12 (int)

        • retention (pulumi.Input[float]) - Retention for etcd backup. Default 6 (int)

        • s3BackupConfig (pulumi.Input[dict]) - S3 config options for etcd backup (list maxitems:1)

          • access_key (pulumi.Input[str]) - The AWS Client ID to use (string)

          • bucketName (pulumi.Input[str]) - Bucket name for S3 service (string)

          • customCa (pulumi.Input[str]) - Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)

          • endpoint (pulumi.Input[str]) - Endpoint for S3 service (string)

          • folder (pulumi.Input[str]) - Folder for S3 service. Available from Rancher v2.2.7 (string)

          • region (pulumi.Input[str]) - The AWS Region to create the EKS cluster in. Default us-west-2 (string)

          • secret_key (pulumi.Input[str]) - The AWS Client Secret associated with the Client ID (string)

      • caCert (pulumi.Input[str]) - TLS CA certificate for etcd service (string)

      • cert (pulumi.Input[str]) - TLS certificate for etcd service (string)

      • creation (pulumi.Input[str]) - Creation option for etcd service (string)

      • externalUrls (pulumi.Input[list]) - External urls for etcd service (list)

      • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

      • extraBinds (pulumi.Input[list]) - Extra binds for scheduler service (list)

      • extraEnvs (pulumi.Input[list]) - Extra environment for scheduler service (list)

      • gid (pulumi.Input[float]) - Etcd service GID. Default: 0. For Rancher v2.3.x or above (int)

      • image (pulumi.Input[str]) - Docker image for scheduler service (string)

      • key (pulumi.Input[str]) - TLS key for etcd service (string)

      • path (pulumi.Input[str]) - Path for etcd service (string)

      • retention (pulumi.Input[str]) - Retention for etcd backup. Default 6 (int)

      • snapshot (pulumi.Input[bool]) - Snapshot option for etcd service (bool)

      • uid (pulumi.Input[float]) - Etcd service UID. Default: 0. For Rancher v2.3.x or above (int)

    • kubeApi (pulumi.Input[dict]) - Kube API options for RKE services (list maxitems:1)

      • alwaysPullImages (pulumi.Input[bool]) - Enable AlwaysPullImages Admission controller plugin. Rancher docs Default: false (bool)

      • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

      • extraBinds (pulumi.Input[list]) - Extra binds for scheduler service (list)

      • extraEnvs (pulumi.Input[list]) - Extra environment for scheduler service (list)

      • image (pulumi.Input[str]) - Docker image for scheduler service (string)

      • podSecurityPolicy (pulumi.Input[bool]) - Pod Security Policy option for kube API service. Default false (bool)

      • serviceClusterIpRange (pulumi.Input[str]) - Service Cluster ip Range option for kube controller service (string)

      • serviceNodePortRange (pulumi.Input[str]) - Service Node Port Range option for kube API service (string)

    • kubeController (pulumi.Input[dict]) - Kube Controller options for RKE services (list maxitems:1)

      • clusterCidr (pulumi.Input[str]) - Cluster CIDR option for kube controller service (string)

      • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

      • extraBinds (pulumi.Input[list]) - Extra binds for scheduler service (list)

      • extraEnvs (pulumi.Input[list]) - Extra environment for scheduler service (list)

      • image (pulumi.Input[str]) - Docker image for scheduler service (string)

      • serviceClusterIpRange (pulumi.Input[str]) - Service Cluster ip Range option for kube controller service (string)

    • kubelet (pulumi.Input[dict]) - Kubelet options for RKE services (list maxitems:1)

      • clusterDnsServer (pulumi.Input[str]) - Cluster DNS Server option for kubelet service (string)

      • clusterDomain (pulumi.Input[str]) - Cluster Domain option for kubelet service (string)

      • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

      • extraBinds (pulumi.Input[list]) - Extra binds for scheduler service (list)

      • extraEnvs (pulumi.Input[list]) - Extra environment for scheduler service (list)

      • failSwapOn (pulumi.Input[bool]) - Enable or disable failing when swap on is not supported (bool)

      • image (pulumi.Input[str]) - Docker image for scheduler service (string)

      • infraContainerImage (pulumi.Input[str]) - Infra container image for kubelet service (string)

    • kubeproxy (pulumi.Input[dict]) - Kubeproxy options for RKE services (list maxitems:1)

      • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

      • extraBinds (pulumi.Input[list]) - Extra binds for scheduler service (list)

      • extraEnvs (pulumi.Input[list]) - Extra environment for scheduler service (list)

      • image (pulumi.Input[str]) - Docker image for scheduler service (string)

    • scheduler (pulumi.Input[dict]) - Scheduler options for RKE services (list maxitems:1)

      • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

      • extraBinds (pulumi.Input[list]) - Extra binds for scheduler service (list)

      • extraEnvs (pulumi.Input[list]) - Extra environment for scheduler service (list)

      • image (pulumi.Input[str]) - Docker image for scheduler service (string)

  • sshAgentAuth (pulumi.Input[bool]) - Use ssh agent auth. Default false (bool)

  • sshKeyPath (pulumi.Input[str]) - Node SSH private key path (string)

aks_config = None

The Azure AKS configuration for aks Clusters. Conflicts with eks_config, gke_config and rke_config (list maxitems:1)

  • aadServerAppSecret (str) - The secret of an Azure Active Directory server application (string)

  • aadTenantId (str) - The ID of an Azure Active Directory tenant (string)

  • addClientAppId (str) - The ID of an Azure Active Directory client application of type “Native”. This application is for user login via kubectl (string)

  • addServerAppId (str) - The ID of an Azure Active Directory server application of type “Web app/API”. This application represents the managed cluster’s apiserver (Server application) (string)

  • adminUsername (str) - The administrator username to use for Linux hosts. Default azureuser (string)

  • agentDnsPrefix (str) - DNS prefix to be used to create the FQDN for the agent pool (string)

  • agentOsDiskSize (float) - GB size to be used to specify the disk for every machine in the agent pool. If you specify 0, it will apply the default according to the “agent vm size” specified. Default 0 (int)

  • agentPoolName (str) - Name for the agent pool, upto 12 alphanumeric characters. Default agentpool0 (string)

  • agentStorageProfile (str) - Storage profile specifies what kind of storage used on machine in the agent pool. Chooses from [ManagedDisks StorageAccount]. Default ManagedDisks (string)

  • agentVmSize (str) - Size of machine in the agent pool. Default Standard_D1_v2 (string)

  • authBaseUrl (str) - Different authentication API url to use. Default https://login.microsoftonline.com/ (string)

  • baseUrl (str) - Different resource management API url to use. Default https://management.azure.com/ (string)

  • client_id (str) - Azure client ID to use (string)

  • client_secret (str) - Azure client secret associated with the “client id” (string)

  • count (float) - Number of machines (VMs) in the agent pool. Allowed values must be in the range of 1 to 100 (inclusive). Default 1 (int)

  • dnsServiceIp (str) - An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes Service address range specified in “service cidr”. Default 10.0.0.10 (string)

  • dockerBridgeCidr (str) - A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes Service address range specified in “service cidr”. Default 172.17.0.1/16 (string)

  • enableHttpApplicationRouting (bool) - Enable the Kubernetes ingress with automatic public DNS name creation. Default false (bool)

  • enableMonitoring (bool) - Turn on Azure Log Analytics monitoring. Uses the Log Analytics “Default” workspace if it exists, else creates one. if using an existing workspace, specifies “log analytics workspace resource id”. Default true (bool)

  • kubernetesVersion (str) - The Kubernetes master version (string)

  • location (str) - Azure Kubernetes cluster location. Default eastus (string)

  • logAnalyticsWorkspace (str) - The name of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses ‘{resource group}-{subscription id}-{location code}’ (string)

  • logAnalyticsWorkspaceResourceGroup (str) - The resource group of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses the ‘Cluster’ resource group (string)

  • masterDnsPrefix (str) - DNS prefix to use the Kubernetes cluster control pane (string)

  • maxPods (float) - Maximum number of pods that can run on a node. Default 110 (int)

  • networkPlugin (str) - Network plugin used for building Kubernetes network. Chooses from azure or kubenet. Default azure (string)

  • networkPolicy (str) - Network policy used for building Kubernetes network. Chooses from calico (string)

  • podCidr (str) - A CIDR notation IP range from which to assign Kubernetes Pod IPs when “network plugin” is specified in “kubenet”. Default 172.244.0.0/16 (string)

  • resourceGroup (str) - The name of the Cluster resource group (string)

  • serviceCidr (str) - A CIDR notation IP range from which to assign Kubernetes Service cluster IPs. It must not overlap with any Subnet IP ranges. Default 10.0.0.0/16 (string)

  • sshPublicKeyContents (str) - Contents of the SSH public key used to authenticate with Linux hosts (string)

  • subnet (str) - The name of an existing Azure Virtual Subnet. Composite of agent virtual network subnet ID (string)

  • subscriptionId (str) - Subscription credentials which uniquely identify Microsoft Azure subscription (string)

  • tag (dict) - Tags for Kubernetes cluster. For example, foo=bar (map)

  • tenant_id (str) - Azure tenant ID to use (string)

  • virtualNetwork (str) - The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

  • virtualNetworkResourceGroup (str) - The resource group of an existing Azure Virtual Network. Composite of agent virtual network subnet ID (string)

annotations = None

Annotations for cluster registration token object (map)

cluster_auth_endpoint = None

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

  • ca_certs (str) - CA certs for the authorized cluster endpoint (string)

  • enabled (bool) - Enable the authorized cluster endpoint. Default true (bool)

  • fqdn (str) - FQDN for the authorized cluster endpoint (string)

cluster_monitoring_input = None

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

  • answers (dict) - Key/value answers for monitor input (map)

cluster_registration_token = None

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

  • annotations (dict) - Annotations for cluster registration token object (map)

  • cluster_id (str) - Cluster ID (string)

  • command (str) - Command to execute in a imported k8s cluster (string)

  • id (str) - (Computed) The ID of the resource (string)

  • insecureCommand (str) - Insecure command to execute in a imported k8s cluster (string)

  • labels (dict) - Labels for cluster registration token object (map)

  • manifestUrl (str) - K8s manifest url to execute with kubectl to import an existing k8s cluster (string)

  • name (str) - Name of cluster registration token (string)

  • nodeCommand (str) - Node command to execute in linux nodes for custom k8s cluster (string)

  • token (str) - Token for cluster registration token object (string)

  • windowsNodeCommand (str) - Node command to execute in windows nodes for custom k8s cluster (string)

cluster_template_answers = None

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

  • cluster_id (str) - Cluster ID (string)

  • project_id (str) - Project ID to apply answer (string)

  • values (dict) - Key/values for answer (map)

cluster_template_id = None

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

cluster_template_questions = None

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

  • default (str) - Default variable value (string)

  • required (bool) - Required variable. Default false (bool)

  • type (str) - Variable type. boolean, int and string are allowed. Default string (string)

  • variable (str) - Variable name (string) ..

    > c6a2cbc… Feat: added .ClusterTemplate datasource and resource. For rancher V2.3.x. Doc files

cluster_template_revision_id = None

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

default_pod_security_policy_template_id = None

Default pod security policy template id (string)

default_project_id = None

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

description = None

An optional description of this cluster (string)

desired_agent_image = None

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

desired_auth_image = None

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

docker_root_dir = None

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

driver = None

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

eks_config = None

The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, gke_config and rke_config (list maxitems:1)

  • access_key (str) - The AWS Client ID to use (string)

  • ami (str) - AMI ID to use for the worker nodes instead of the default (string)

  • associateWorkerNodePublicIp (bool) - Associate public ip EKS worker nodes. Default true (bool)

  • desiredNodes (float) - The desired number of worker nodes. Just for Rancher v2.3.x and above. Default 3 (int)

  • instanceType (str) - The type of machine to use for worker nodes. Default t2.medium (string)

  • keyPairName (str) - Allow user to specify key name to use. Just for Rancher v2.2.7 and above (string)

  • kubernetesVersion (str) - The Kubernetes master version (string)

  • maximumNodes (float) - The maximum number of worker nodes. Default 3 (int)

  • minimumNodes (float) - The minimum number of worker nodes. Default 1 (int)

  • nodeVolumeSize (float) - The volume size for each node. Default 20 (int)

  • region (str) - The AWS Region to create the EKS cluster in. Default us-west-2 (string)

  • secret_key (str) - The AWS Client Secret associated with the Client ID (string)

  • securityGroups (list) - List of security groups to use for the cluster. If it’s not specified Rancher will create a new security group (list)

  • serviceRole (str) - The service role to use to perform the cluster operations in AWS. If it’s not specified Rancher will create a new service role (string)

  • sessionToken (str) - A session token to use with the client key and secret if applicable (string)

  • subnets (list) - List of subnets in the virtual network to use. If it’s not specified Rancher will create 3 news subnets (list)

  • userData (str) - Pass user-data to the nodes to perform automated configuration tasks (string)

  • virtualNetwork (str) - The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

enable_cluster_alerting = None

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

enable_cluster_istio = None

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

enable_cluster_monitoring = None

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

enable_network_policy = None

Enable project network isolation. Default false (bool)

gke_config = None

The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config and rke_config (list maxitems:1)

  • clusterIpv4Cidr (str) - The IP address range of the container pods (string)

  • credential (str) - The contents of the GC credential file (string)

  • description (str) - An optional description of this cluster (string)

  • diskSizeGb (float) - Size of the disk attached to each node. Default 100 (int)

  • diskType (str) - Type of the disk attached to each node (string)

  • enableAlphaFeature (bool) - To enable Kubernetes alpha feature. Default true (bool)

  • enableAutoRepair (bool) - Specifies whether the node auto-repair is enabled for the node pool. Default false (bool)

  • enableAutoUpgrade (bool) - Specifies whether node auto-upgrade is enabled for the node pool. Default false (bool)

  • enableHorizontalPodAutoscaling (bool) - Enable horizontal pod autoscaling for the cluster. Default true (bool)

  • enableHttpLoadBalancing (bool) - Enable HTTP load balancing on GKE cluster. Default true (bool)

  • enableKubernetesDashboard (bool) - Whether to enable the Kubernetes dashboard. Default false (bool)

  • enableLegacyAbac (bool) - Whether to enable legacy abac on the cluster. Default false (bool)

  • enableMasterAuthorizedNetwork (bool)

  • enableNetworkPolicyConfig (bool) - Enable stackdriver logging. Default true (bool)

  • enableNodepoolAutoscaling (bool) - Enable nodepool autoscaling. Default false (bool)

  • enablePrivateEndpoint (bool) - Whether the master’s internal IP address is used as the cluster endpoint. Default false (bool)

  • enablePrivateNodes (bool) - Whether nodes have internal IP address only. Default false (bool)

  • enableStackdriverLogging (bool) - Enable stackdriver monitoring. Default true (bool)

  • enableStackdriverMonitoring (bool) - Enable stackdriver monitoring on GKE cluster (bool)

  • imageType (str) - The image to use for the worker nodes (string)

  • ipPolicyClusterIpv4CidrBlock (str) - The IP address range for the cluster pod IPs (string)

  • ipPolicyClusterSecondaryRangeName (str) - The name of the secondary range to be used for the cluster CIDR block (string)

  • ipPolicyCreateSubnetwork (bool) - Whether a new subnetwork will be created automatically for the cluster. Default false (bool)

  • ipPolicyNodeIpv4CidrBlock (str) - The IP address range of the instance IPs in this cluster (string)

  • ipPolicyServicesIpv4CidrBlock (str) - The IP address range of the services IPs in this cluster (string)

  • ipPolicyServicesSecondaryRangeName (str) - The name of the secondary range to be used for the services CIDR block (string)

  • ipPolicySubnetworkName (str) - A custom subnetwork name to be used if createSubnetwork is true (string)

  • issueClientCertificate (bool) - Issue a client certificate. Default false (bool)

  • kubernetesDashboard (bool) - Enable the Kubernetes dashboard. Default false (bool)

  • labels (dict) - Labels for cluster registration token object (map)

  • localSsdCount (float) - The number of local SSD disks to be attached to the node. Default 0 (int)

  • locations (list) - Locations for GKE cluster (list)

  • machineType (str) - Machine type for GKE cluster (string)

  • maintenanceWindow (str) - Maintenance window for GKE cluster (string)

  • masterAuthorizedNetworkCidrBlocks (list) - Define up to 10 external networks that could access Kubernetes master through HTTPS (list)

  • masterIpv4CidrBlock (str) - The IP range in CIDR notation to use for the hosted master network (string)

  • masterVersion (str) - Master version for GKE cluster (string)

  • maxNodeCount (float) - Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. Default 0 (int)

  • minNodeCount (float) - Minimmum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. Default 0 (int)

  • network (str) - Network for GKE cluster (string)

  • nodeCount (float) - Node count for GKE cluster. Default 3 (int)

  • nodePool (str) - The ID of the cluster node pool (string)

  • nodeVersion (str) - Node version for GKE cluster (string)

  • oauthScopes (list) - The set of Google API scopes to be made available on all of the node VMs under the default service account (list)

  • preemptible (bool) - Whether the nodes are created as preemptible VM instances. Default false (bool)

  • project_id (str) - Project ID to apply answer (string)

  • resourceLabels (dict) - The map of Kubernetes labels to be applied to each cluster (map)

  • serviceAccount (str) - The Google Cloud Platform Service Account to be used by the node VMs (string)

  • subNetwork (str) - Subnetwork for GKE cluster (string)

  • taints (list) - List of Kubernetes taints to be applied to each node (list)

  • useIpAliases (bool) - Whether alias IPs will be used for pod IPs in the cluster. Default false (bool)

  • zone (str) - Zone GKE cluster (string)

kube_config = None

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

labels = None

Labels for cluster registration token object (map)

name = None

Name of cluster registration token (string)

rke_config = None

The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config and gke_config (list maxitems:1)

  • addonJobTimeout (float) - Duration in seconds of addon job (int)

  • addons (str) - Addons descripton to deploy on RKE cluster.

  • addonsIncludes (list) - Addons yaml manifests to deploy on RKE cluster (list)

  • authentication (dict) - Kubernetes cluster authentication (list maxitems:1)

    • sans (list) - RKE sans for authentication ([]string)

    • strategy (str) - RKE strategy for authentication (string)

  • authorization (dict) - Kubernetes cluster authorization (list maxitems:1)

    • mode (str) - RKE mode for authorization. rbac and none modes are available. Default rbac (string)

    • options (dict) - RKE options for network (map)

  • bastionHost (dict) - RKE bastion host (list maxitems:1)

    • address (str) - Address ip for node (string)

    • port (str) - Port for node. Default 22 (string)

    • sshAgentAuth (bool) - Use ssh agent auth. Default false (bool)

    • sshKey (str) - Node SSH private key (string)

    • sshKeyPath (str) - Node SSH private key path (string)

    • user (str) - Registry user (string)

  • cloudProvider (dict) - RKE options for Calico network provider (string)

    • awsCloudProvider (dict) - RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)

      • global (dict) - (list maxitems:1)

        • disableSecurityGroupIngress (bool) - Default false (bool)

        • disableStrictZoneCheck (bool) - Default false (bool)

        • elbSecurityGroup (str) - (string)

        • kubernetesClusterId (str) - (string)

        • kubernetesClusterTag (str) - (string)

        • roleArn (str) - (string)

        • routeTableId (str) - (string)

        • subnetId (str) - (string)

        • vpc (str) - (string)

        • zone (str) - Zone GKE cluster (string)

      • serviceOverrides (list) - (list)

        • region (str) - The AWS Region to create the EKS cluster in. Default us-west-2 (string)

        • service (str) - (string)

        • signingMethod (str) - (string)

        • signingName (str) - (string)

        • signingRegion (str) - (string)

        • url (str) - Registry URL (string)

    • azureCloudProvider (dict) - RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)

      • aadClientCertPassword (str) - (string)

      • aadClientCertPath (str) - (string)

      • aadClientId (str) - (string)

      • aadClientSecret (str) - (string)

      • cloud (str) - (string)

      • cloudProviderBackoff (bool) - (bool)

      • cloudProviderBackoffDuration (float) - (int)

      • cloudProviderBackoffExponent (float) - (int)

      • cloudProviderBackoffJitter (float) - (int)

      • cloudProviderBackoffRetries (float) - (int)

      • cloudProviderRateLimit (bool) - (bool)

      • cloudProviderRateLimitBucket (float) - (int)

      • cloudProviderRateLimitQps (float) - (int)

      • location (str) - Azure Kubernetes cluster location. Default eastus (string)

      • maximumLoadBalancerRuleCount (float) - (int)

      • primaryAvailabilitySetName (str) - (string)

      • primaryScaleSetName (str) - (string)

      • resourceGroup (str) - The name of the Cluster resource group (string)

      • routeTableName (str) - (string)

      • securityGroupName (str) - (string)

      • subnetName (str) - (string)

      • subscriptionId (str) - Subscription credentials which uniquely identify Microsoft Azure subscription (string)

      • tenant_id (str) - Azure tenant ID to use (string)

      • useInstanceMetadata (bool) - (bool)

      • useManagedIdentityExtension (bool) - (bool)

      • vmType (str) - (string)

      • vnetName (str) - (string)

      • vnetResourceGroup (str) - (string)

    • customCloudProvider (str) - RKE Custom Cloud Provider config for Cloud Provider (string) (string)

    • name (str) - Name of cluster registration token (string)

    • openstackCloudProvider (dict) - RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)

      • blockStorage (dict) - (list maxitems:1)

        • bsVersion (str) - (string)

        • ignoreVolumeAz (bool) - (string)

        • trustDevicePath (bool) - (string)

      • global (dict) - (list maxitems:1)

        • authUrl (str) - (string)

        • caFile (str) - (string)

        • domainId (str) - Required if domain_name not provided. (string)

        • domainName (str) - Required if domain_id not provided. (string)

        • password (str) - Registry password (string)

        • region (str) - The AWS Region to create the EKS cluster in. Default us-west-2 (string)

        • tenant_id (str) - Azure tenant ID to use (string)

        • tenantName (str) - Required if tenant_id not provided. (string)

        • trustId (str) - (string)

        • username (str) - (string)

      • loadBalancer (dict) - (list maxitems:1)

        • createMonitor (bool) - (bool)

        • floatingNetworkId (str) - (string)

        • lbMethod (str) - (string)

        • lbProvider (str) - (string)

        • lbVersion (str) - (string)

        • manageSecurityGroups (bool) - (bool)

        • monitorDelay (str) - Default 60s (string)

        • monitorMaxRetries (float) - Default 5 (int)

        • monitorTimeout (str) - Default 30s (string)

        • subnetId (str) - (string)

        • useOctavia (bool) - (bool)

      • metadata (dict) - (list maxitems:1)

        • requestTimeout (float) - (int)

        • searchOrder (str) - (string)

      • route (dict) - (list maxitems:1)

        • routerId (str) - (string)

    • vsphereCloudProvider (dict) - RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument name is required on virtual_center configuration. (list maxitems:1)

      • disk (dict) - (list maxitems:1)

        • scsiControllerType (str) - (string)

      • global (dict) - (list maxitems:1)

        • datacenters (str) - (string)

        • insecureFlag (bool) - (bool)

        • password (str) - Registry password (string)

        • port (str) - Port for node. Default 22 (string)

        • soapRoundtripCount (float) - (int)

        • user (str) - Registry user (string)

      • network (dict) - Network for GKE cluster (string)

        • publicNetwork (str) - (string)

      • virtualCenters (list) - (List)

        • datacenters (str) - (string)

        • name (str) - Name of cluster registration token (string)

        • password (str) - Registry password (string)

        • port (str) - Port for node. Default 22 (string)

        • soapRoundtripCount (float) - (int)

        • user (str) - Registry user (string)

      • workspace (dict) - (list maxitems:1)

        • datacenter (str) - (string)

        • defaultDatastore (str) - (string)

        • folder (str) - Folder for S3 service. Available from Rancher v2.2.7 (string)

        • resourcepoolPath (str) - (string)

        • server (str) - (string)

  • dns (dict) - RKE dns add-on. Just for Rancher v2.2.x (list maxitems:1)

    • nodeSelector (dict) - Node selector for RKE Ingress (map)

    • provider (str) - Provider for RKE monitoring (string)

    • reverseCidrs (list) - DNS add-on reverse cidr (list)

    • upstreamNameservers (list) - DNS add-on upstream nameservers (list)

  • ignoreDockerVersion (bool) - Ignore docker version. Default true (bool)

  • ingress (dict) - Kubernetes ingress configuration (list maxitems:1)

    • extraArgs (dict) - Extra arguments for scheduler service (map)

    • nodeSelector (dict) - Node selector for RKE Ingress (map)

    • options (dict) - RKE options for network (map)

    • provider (str) - Provider for RKE monitoring (string)

  • kubernetesVersion (str) - The Kubernetes master version (string)

  • monitoring (dict) - Kubernetes cluster monitoring (list maxitems:1)

    • options (dict) - RKE options for network (map)

    • provider (str) - Provider for RKE monitoring (string)

  • network (dict) - Network for GKE cluster (string)

    • calicoNetworkProvider (dict) - Calico provider config for RKE network (list maxitems:1)

      • cloudProvider (str) - RKE options for Calico network provider (string)

    • canalNetworkProvider (dict) - Canal provider config for RKE network (list maxitems:1)

      • iface (str) - Iface config Flannel network provider (string)

    • flannelNetworkProvider (dict) - Flannel provider config for RKE network (list maxitems:1)

      • iface (str) - Iface config Flannel network provider (string)

    • options (dict) - RKE options for network (map)

    • plugin (str) - Plugin for RKE network. canal (default), flannel, calico and weave are supported. (string)

    • weaveNetworkProvider (dict) - Weave provider config for RKE network (list maxitems:1)

      • password (str) - Registry password (string)

  • nodes (list) - RKE cluster nodes (list)

    • address (str) - Address ip for node (string)

    • dockerSocket (str) - Docker socket for node (string)

    • hostnameOverride (str) - Hostname override for node (string)

    • internalAddress (str) - Internal ip for node (string)

    • labels (dict) - Labels for cluster registration token object (map)

    • nodeId (str) - Id for the node (string)

    • port (str) - Port for node. Default 22 (string)

    • roles (list) - Roles for the node. controlplane, etcd and worker are supported. (list)

    • sshAgentAuth (bool) - Use ssh agent auth. Default false (bool)

    • sshKey (str) - Node SSH private key (string)

    • sshKeyPath (str) - Node SSH private key path (string)

    • user (str) - Registry user (string)

  • prefixPath (str) - Prefix to customize Kubernetes path (string)

  • privateRegistries (list) - private registries for docker images (list)

    • isDefault (bool) - Set as default registry. Default false (bool)

    • password (str) - Registry password (string)

    • url (str) - Registry URL (string)

    • user (str) - Registry user (string)

  • services (dict) - Kubernetes cluster services (list maxitems:1)

    • etcd (dict) - Etcd options for RKE services (list maxitems:1)

      • backup_config (dict) - Backup options for etcd service. Just for Rancher v2.2.x (list maxitems:1)

        • enabled (bool) - Enable the authorized cluster endpoint. Default true (bool)

        • intervalHours (float) - Interval hours for etcd backup. Default 12 (int)

        • retention (float) - Retention for etcd backup. Default 6 (int)

        • s3BackupConfig (dict) - S3 config options for etcd backup (list maxitems:1)

          • access_key (str) - The AWS Client ID to use (string)

          • bucketName (str) - Bucket name for S3 service (string)

          • customCa (str) - Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)

          • endpoint (str) - Endpoint for S3 service (string)

          • folder (str) - Folder for S3 service. Available from Rancher v2.2.7 (string)

          • region (str) - The AWS Region to create the EKS cluster in. Default us-west-2 (string)

          • secret_key (str) - The AWS Client Secret associated with the Client ID (string)

      • caCert (str) - TLS CA certificate for etcd service (string)

      • cert (str) - TLS certificate for etcd service (string)

      • creation (str) - Creation option for etcd service (string)

      • externalUrls (list) - External urls for etcd service (list)

      • extraArgs (dict) - Extra arguments for scheduler service (map)

      • extraBinds (list) - Extra binds for scheduler service (list)

      • extraEnvs (list) - Extra environment for scheduler service (list)

      • gid (float) - Etcd service GID. Default: 0. For Rancher v2.3.x or above (int)

      • image (str) - Docker image for scheduler service (string)

      • key (str) - TLS key for etcd service (string)

      • path (str) - Path for etcd service (string)

      • retention (str) - Retention for etcd backup. Default 6 (int)

      • snapshot (bool) - Snapshot option for etcd service (bool)

      • uid (float) - Etcd service UID. Default: 0. For Rancher v2.3.x or above (int)

    • kubeApi (dict) - Kube API options for RKE services (list maxitems:1)

      • alwaysPullImages (bool) - Enable AlwaysPullImages Admission controller plugin. Rancher docs Default: false (bool)

      • extraArgs (dict) - Extra arguments for scheduler service (map)

      • extraBinds (list) - Extra binds for scheduler service (list)

      • extraEnvs (list) - Extra environment for scheduler service (list)

      • image (str) - Docker image for scheduler service (string)

      • podSecurityPolicy (bool) - Pod Security Policy option for kube API service. Default false (bool)

      • serviceClusterIpRange (str) - Service Cluster ip Range option for kube controller service (string)

      • serviceNodePortRange (str) - Service Node Port Range option for kube API service (string)

    • kubeController (dict) - Kube Controller options for RKE services (list maxitems:1)

      • clusterCidr (str) - Cluster CIDR option for kube controller service (string)

      • extraArgs (dict) - Extra arguments for scheduler service (map)

      • extraBinds (list) - Extra binds for scheduler service (list)

      • extraEnvs (list) - Extra environment for scheduler service (list)

      • image (str) - Docker image for scheduler service (string)

      • serviceClusterIpRange (str) - Service Cluster ip Range option for kube controller service (string)

    • kubelet (dict) - Kubelet options for RKE services (list maxitems:1)

      • clusterDnsServer (str) - Cluster DNS Server option for kubelet service (string)

      • clusterDomain (str) - Cluster Domain option for kubelet service (string)

      • extraArgs (dict) - Extra arguments for scheduler service (map)

      • extraBinds (list) - Extra binds for scheduler service (list)

      • extraEnvs (list) - Extra environment for scheduler service (list)

      • failSwapOn (bool) - Enable or disable failing when swap on is not supported (bool)

      • image (str) - Docker image for scheduler service (string)

      • infraContainerImage (str) - Infra container image for kubelet service (string)

    • kubeproxy (dict) - Kubeproxy options for RKE services (list maxitems:1)

      • extraArgs (dict) - Extra arguments for scheduler service (map)

      • extraBinds (list) - Extra binds for scheduler service (list)

      • extraEnvs (list) - Extra environment for scheduler service (list)

      • image (str) - Docker image for scheduler service (string)

    • scheduler (dict) - Scheduler options for RKE services (list maxitems:1)

      • extraArgs (dict) - Extra arguments for scheduler service (map)

      • extraBinds (list) - Extra binds for scheduler service (list)

      • extraEnvs (list) - Extra environment for scheduler service (list)

      • image (str) - Docker image for scheduler service (string)

  • sshAgentAuth (bool) - Use ssh agent auth. Default false (bool)

  • sshKeyPath (str) - Node SSH private key path (string)

system_project_id = None

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

static get(resource_name, id, opts=None, aks_config=None, annotations=None, cluster_auth_endpoint=None, cluster_monitoring_input=None, cluster_registration_token=None, cluster_template_answers=None, cluster_template_id=None, cluster_template_questions=None, cluster_template_revision_id=None, default_pod_security_policy_template_id=None, default_project_id=None, description=None, desired_agent_image=None, desired_auth_image=None, docker_root_dir=None, driver=None, eks_config=None, enable_cluster_alerting=None, enable_cluster_istio=None, enable_cluster_monitoring=None, enable_network_policy=None, gke_config=None, kube_config=None, labels=None, name=None, rke_config=None, system_project_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • aks_config (pulumi.Input[dict]) – The Azure AKS configuration for aks Clusters. Conflicts with eks_config, gke_config and rke_config (list maxitems:1)

  • annotations (pulumi.Input[dict]) – Annotations for cluster registration token object (map)

  • cluster_auth_endpoint (pulumi.Input[dict]) –

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

  • cluster_monitoring_input (pulumi.Input[dict]) –

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

  • cluster_registration_token (pulumi.Input[dict]) – (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)

  • cluster_template_answers (pulumi.Input[dict]) – Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)

  • cluster_template_id (pulumi.Input[str]) – Cluster template ID. Just for Rancher v2.3.x and above (string)

  • cluster_template_questions (pulumi.Input[list]) – Cluster template questions. Just for Rancher v2.3.x and above (list)

  • cluster_template_revision_id (pulumi.Input[str]) – Cluster template revision ID. Just for Rancher v2.3.x and above (string)

  • default_pod_security_policy_template_id (pulumi.Input[str]) –

    Default pod security policy template id (string)

  • default_project_id (pulumi.Input[str]) – (Computed) Default project ID for the cluster (string)

  • description (pulumi.Input[str]) – An optional description of this cluster (string)

  • desired_agent_image (pulumi.Input[str]) – Desired agent image. Just for Rancher v2.3.x and above (string)

  • desired_auth_image (pulumi.Input[str]) – Desired auth image. Just for Rancher v2.3.x and above (string)

  • docker_root_dir (pulumi.Input[str]) – Desired auth image. Just for Rancher v2.3.x and above (string)

  • driver (pulumi.Input[str]) – (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)

  • eks_config (pulumi.Input[dict]) – The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, gke_config and rke_config (list maxitems:1)

  • enable_cluster_alerting (pulumi.Input[bool]) – Enable built-in cluster alerting. Default false (bool)

  • enable_cluster_istio (pulumi.Input[bool]) – Enable built-in cluster istio. Default false. Just for Rancher v2.3.x and above (bool)

  • enable_cluster_monitoring (pulumi.Input[bool]) – Enable built-in cluster monitoring. Default false (bool)

  • enable_network_policy (pulumi.Input[bool]) – Enable project network isolation. Default false (bool)

  • gke_config (pulumi.Input[dict]) – The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config and rke_config (list maxitems:1)

  • kube_config (pulumi.Input[str]) – (Computed) Kube Config generated for the cluster (string)

  • labels (pulumi.Input[dict]) – Labels for cluster registration token object (map)

  • name (pulumi.Input[str]) – Name of cluster registration token (string)

  • rke_config (pulumi.Input[dict]) – The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config and gke_config (list maxitems:1)

  • system_project_id (pulumi.Input[str]) – (Computed) System project ID for the cluster (string)

The aks_config object supports the following:

  • aadServerAppSecret (pulumi.Input[str]) - The secret of an Azure Active Directory server application (string)

  • aadTenantId (pulumi.Input[str]) - The ID of an Azure Active Directory tenant (string)

  • addClientAppId (pulumi.Input[str]) - The ID of an Azure Active Directory client application of type “Native”. This application is for user login via kubectl (string)

  • addServerAppId (pulumi.Input[str]) - The ID of an Azure Active Directory server application of type “Web app/API”. This application represents the managed cluster’s apiserver (Server application) (string)

  • adminUsername (pulumi.Input[str]) - The administrator username to use for Linux hosts. Default azureuser (string)

  • agentDnsPrefix (pulumi.Input[str]) - DNS prefix to be used to create the FQDN for the agent pool (string)

  • agentOsDiskSize (pulumi.Input[float]) - GB size to be used to specify the disk for every machine in the agent pool. If you specify 0, it will apply the default according to the “agent vm size” specified. Default 0 (int)

  • agentPoolName (pulumi.Input[str]) - Name for the agent pool, upto 12 alphanumeric characters. Default agentpool0 (string)

  • agentStorageProfile (pulumi.Input[str]) - Storage profile specifies what kind of storage used on machine in the agent pool. Chooses from [ManagedDisks StorageAccount]. Default ManagedDisks (string)

  • agentVmSize (pulumi.Input[str]) - Size of machine in the agent pool. Default Standard_D1_v2 (string)

  • authBaseUrl (pulumi.Input[str]) - Different authentication API url to use. Default https://login.microsoftonline.com/ (string)

  • baseUrl (pulumi.Input[str]) - Different resource management API url to use. Default https://management.azure.com/ (string)

  • client_id (pulumi.Input[str]) - Azure client ID to use (string)

  • client_secret (pulumi.Input[str]) - Azure client secret associated with the “client id” (string)

  • count (pulumi.Input[float]) - Number of machines (VMs) in the agent pool. Allowed values must be in the range of 1 to 100 (inclusive). Default 1 (int)

  • dnsServiceIp (pulumi.Input[str]) - An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes Service address range specified in “service cidr”. Default 10.0.0.10 (string)

  • dockerBridgeCidr (pulumi.Input[str]) - A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes Service address range specified in “service cidr”. Default 172.17.0.1/16 (string)

  • enableHttpApplicationRouting (pulumi.Input[bool]) - Enable the Kubernetes ingress with automatic public DNS name creation. Default false (bool)

  • enableMonitoring (pulumi.Input[bool]) - Turn on Azure Log Analytics monitoring. Uses the Log Analytics “Default” workspace if it exists, else creates one. if using an existing workspace, specifies “log analytics workspace resource id”. Default true (bool)

  • kubernetesVersion (pulumi.Input[str]) - The Kubernetes master version (string)

  • location (pulumi.Input[str]) - Azure Kubernetes cluster location. Default eastus (string)

  • logAnalyticsWorkspace (pulumi.Input[str]) - The name of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses ‘{resource group}-{subscription id}-{location code}’ (string)

  • logAnalyticsWorkspaceResourceGroup (pulumi.Input[str]) - The resource group of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses the ‘Cluster’ resource group (string)

  • masterDnsPrefix (pulumi.Input[str]) - DNS prefix to use the Kubernetes cluster control pane (string)

  • maxPods (pulumi.Input[float]) - Maximum number of pods that can run on a node. Default 110 (int)

  • networkPlugin (pulumi.Input[str]) - Network plugin used for building Kubernetes network. Chooses from azure or kubenet. Default azure (string)

  • networkPolicy (pulumi.Input[str]) - Network policy used for building Kubernetes network. Chooses from calico (string)

  • podCidr (pulumi.Input[str]) - A CIDR notation IP range from which to assign Kubernetes Pod IPs when “network plugin” is specified in “kubenet”. Default 172.244.0.0/16 (string)

  • resourceGroup (pulumi.Input[str]) - The name of the Cluster resource group (string)

  • serviceCidr (pulumi.Input[str]) - A CIDR notation IP range from which to assign Kubernetes Service cluster IPs. It must not overlap with any Subnet IP ranges. Default 10.0.0.0/16 (string)

  • sshPublicKeyContents (pulumi.Input[str]) - Contents of the SSH public key used to authenticate with Linux hosts (string)

  • subnet (pulumi.Input[str]) - The name of an existing Azure Virtual Subnet. Composite of agent virtual network subnet ID (string)

  • subscriptionId (pulumi.Input[str]) - Subscription credentials which uniquely identify Microsoft Azure subscription (string)

  • tag (pulumi.Input[dict]) - Tags for Kubernetes cluster. For example, foo=bar (map)

  • tenant_id (pulumi.Input[str]) - Azure tenant ID to use (string)

  • virtualNetwork (pulumi.Input[str]) - The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

  • virtualNetworkResourceGroup (pulumi.Input[str]) - The resource group of an existing Azure Virtual Network. Composite of agent virtual network subnet ID (string)

The cluster_auth_endpoint object supports the following:

  • ca_certs (pulumi.Input[str]) - CA certs for the authorized cluster endpoint (string)

  • enabled (pulumi.Input[bool]) - Enable the authorized cluster endpoint. Default true (bool)

  • fqdn (pulumi.Input[str]) - FQDN for the authorized cluster endpoint (string)

The cluster_monitoring_input object supports the following:

  • answers (pulumi.Input[dict]) - Key/value answers for monitor input (map)

The cluster_registration_token object supports the following:

  • annotations (pulumi.Input[dict]) - Annotations for cluster registration token object (map)

  • cluster_id (pulumi.Input[str]) - Cluster ID (string)

  • command (pulumi.Input[str]) - Command to execute in a imported k8s cluster (string)

  • id (pulumi.Input[str]) - (Computed) The ID of the resource (string)

  • insecureCommand (pulumi.Input[str]) - Insecure command to execute in a imported k8s cluster (string)

  • labels (pulumi.Input[dict]) - Labels for cluster registration token object (map)

  • manifestUrl (pulumi.Input[str]) - K8s manifest url to execute with kubectl to import an existing k8s cluster (string)

  • name (pulumi.Input[str]) - Name of cluster registration token (string)

  • nodeCommand (pulumi.Input[str]) - Node command to execute in linux nodes for custom k8s cluster (string)

  • token (pulumi.Input[str]) - Token for cluster registration token object (string)

  • windowsNodeCommand (pulumi.Input[str]) - Node command to execute in windows nodes for custom k8s cluster (string)

The cluster_template_answers object supports the following:

  • cluster_id (pulumi.Input[str]) - Cluster ID (string)

  • project_id (pulumi.Input[str]) - Project ID to apply answer (string)

  • values (pulumi.Input[dict]) - Key/values for answer (map)

The cluster_template_questions object supports the following:

  • default (pulumi.Input[str]) - Default variable value (string)

  • required (pulumi.Input[bool]) - Required variable. Default false (bool)

  • type (pulumi.Input[str]) - Variable type. boolean, int and string are allowed. Default string (string)

  • variable (pulumi.Input[str]) - Variable name (string) ..

    > c6a2cbc… Feat: added .ClusterTemplate datasource and resource. For rancher V2.3.x. Doc files

The eks_config object supports the following:

  • access_key (pulumi.Input[str]) - The AWS Client ID to use (string)

  • ami (pulumi.Input[str]) - AMI ID to use for the worker nodes instead of the default (string)

  • associateWorkerNodePublicIp (pulumi.Input[bool]) - Associate public ip EKS worker nodes. Default true (bool)

  • desiredNodes (pulumi.Input[float]) - The desired number of worker nodes. Just for Rancher v2.3.x and above. Default 3 (int)

  • instanceType (pulumi.Input[str]) - The type of machine to use for worker nodes. Default t2.medium (string)

  • keyPairName (pulumi.Input[str]) - Allow user to specify key name to use. Just for Rancher v2.2.7 and above (string)

  • kubernetesVersion (pulumi.Input[str]) - The Kubernetes master version (string)

  • maximumNodes (pulumi.Input[float]) - The maximum number of worker nodes. Default 3 (int)

  • minimumNodes (pulumi.Input[float]) - The minimum number of worker nodes. Default 1 (int)

  • nodeVolumeSize (pulumi.Input[float]) - The volume size for each node. Default 20 (int)

  • region (pulumi.Input[str]) - The AWS Region to create the EKS cluster in. Default us-west-2 (string)

  • secret_key (pulumi.Input[str]) - The AWS Client Secret associated with the Client ID (string)

  • securityGroups (pulumi.Input[list]) - List of security groups to use for the cluster. If it’s not specified Rancher will create a new security group (list)

  • serviceRole (pulumi.Input[str]) - The service role to use to perform the cluster operations in AWS. If it’s not specified Rancher will create a new service role (string)

  • sessionToken (pulumi.Input[str]) - A session token to use with the client key and secret if applicable (string)

  • subnets (pulumi.Input[list]) - List of subnets in the virtual network to use. If it’s not specified Rancher will create 3 news subnets (list)

  • userData (pulumi.Input[str]) - Pass user-data to the nodes to perform automated configuration tasks (string)

  • virtualNetwork (pulumi.Input[str]) - The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

The gke_config object supports the following:

  • clusterIpv4Cidr (pulumi.Input[str]) - The IP address range of the container pods (string)

  • credential (pulumi.Input[str]) - The contents of the GC credential file (string)

  • description (pulumi.Input[str]) - An optional description of this cluster (string)

  • diskSizeGb (pulumi.Input[float]) - Size of the disk attached to each node. Default 100 (int)

  • diskType (pulumi.Input[str]) - Type of the disk attached to each node (string)

  • enableAlphaFeature (pulumi.Input[bool]) - To enable Kubernetes alpha feature. Default true (bool)

  • enableAutoRepair (pulumi.Input[bool]) - Specifies whether the node auto-repair is enabled for the node pool. Default false (bool)

  • enableAutoUpgrade (pulumi.Input[bool]) - Specifies whether node auto-upgrade is enabled for the node pool. Default false (bool)

  • enableHorizontalPodAutoscaling (pulumi.Input[bool]) - Enable horizontal pod autoscaling for the cluster. Default true (bool)

  • enableHttpLoadBalancing (pulumi.Input[bool]) - Enable HTTP load balancing on GKE cluster. Default true (bool)

  • enableKubernetesDashboard (pulumi.Input[bool]) - Whether to enable the Kubernetes dashboard. Default false (bool)

  • enableLegacyAbac (pulumi.Input[bool]) - Whether to enable legacy abac on the cluster. Default false (bool)

  • enableMasterAuthorizedNetwork (pulumi.Input[bool])

  • enableNetworkPolicyConfig (pulumi.Input[bool]) - Enable stackdriver logging. Default true (bool)

  • enableNodepoolAutoscaling (pulumi.Input[bool]) - Enable nodepool autoscaling. Default false (bool)

  • enablePrivateEndpoint (pulumi.Input[bool]) - Whether the master’s internal IP address is used as the cluster endpoint. Default false (bool)

  • enablePrivateNodes (pulumi.Input[bool]) - Whether nodes have internal IP address only. Default false (bool)

  • enableStackdriverLogging (pulumi.Input[bool]) - Enable stackdriver monitoring. Default true (bool)

  • enableStackdriverMonitoring (pulumi.Input[bool]) - Enable stackdriver monitoring on GKE cluster (bool)

  • imageType (pulumi.Input[str]) - The image to use for the worker nodes (string)

  • ipPolicyClusterIpv4CidrBlock (pulumi.Input[str]) - The IP address range for the cluster pod IPs (string)

  • ipPolicyClusterSecondaryRangeName (pulumi.Input[str]) - The name of the secondary range to be used for the cluster CIDR block (string)

  • ipPolicyCreateSubnetwork (pulumi.Input[bool]) - Whether a new subnetwork will be created automatically for the cluster. Default false (bool)

  • ipPolicyNodeIpv4CidrBlock (pulumi.Input[str]) - The IP address range of the instance IPs in this cluster (string)

  • ipPolicyServicesIpv4CidrBlock (pulumi.Input[str]) - The IP address range of the services IPs in this cluster (string)

  • ipPolicyServicesSecondaryRangeName (pulumi.Input[str]) - The name of the secondary range to be used for the services CIDR block (string)

  • ipPolicySubnetworkName (pulumi.Input[str]) - A custom subnetwork name to be used if createSubnetwork is true (string)

  • issueClientCertificate (pulumi.Input[bool]) - Issue a client certificate. Default false (bool)

  • kubernetesDashboard (pulumi.Input[bool]) - Enable the Kubernetes dashboard. Default false (bool)

  • labels (pulumi.Input[dict]) - Labels for cluster registration token object (map)

  • localSsdCount (pulumi.Input[float]) - The number of local SSD disks to be attached to the node. Default 0 (int)

  • locations (pulumi.Input[list]) - Locations for GKE cluster (list)

  • machineType (pulumi.Input[str]) - Machine type for GKE cluster (string)

  • maintenanceWindow (pulumi.Input[str]) - Maintenance window for GKE cluster (string)

  • masterAuthorizedNetworkCidrBlocks (pulumi.Input[list]) - Define up to 10 external networks that could access Kubernetes master through HTTPS (list)

  • masterIpv4CidrBlock (pulumi.Input[str]) - The IP range in CIDR notation to use for the hosted master network (string)

  • masterVersion (pulumi.Input[str]) - Master version for GKE cluster (string)

  • maxNodeCount (pulumi.Input[float]) - Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. Default 0 (int)

  • minNodeCount (pulumi.Input[float]) - Minimmum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. Default 0 (int)

  • network (pulumi.Input[str]) - Network for GKE cluster (string)

  • nodeCount (pulumi.Input[float]) - Node count for GKE cluster. Default 3 (int)

  • nodePool (pulumi.Input[str]) - The ID of the cluster node pool (string)

  • nodeVersion (pulumi.Input[str]) - Node version for GKE cluster (string)

  • oauthScopes (pulumi.Input[list]) - The set of Google API scopes to be made available on all of the node VMs under the default service account (list)

  • preemptible (pulumi.Input[bool]) - Whether the nodes are created as preemptible VM instances. Default false (bool)

  • project_id (pulumi.Input[str]) - Project ID to apply answer (string)

  • resourceLabels (pulumi.Input[dict]) - The map of Kubernetes labels to be applied to each cluster (map)

  • serviceAccount (pulumi.Input[str]) - The Google Cloud Platform Service Account to be used by the node VMs (string)

  • subNetwork (pulumi.Input[str]) - Subnetwork for GKE cluster (string)

  • taints (pulumi.Input[list]) - List of Kubernetes taints to be applied to each node (list)

  • useIpAliases (pulumi.Input[bool]) - Whether alias IPs will be used for pod IPs in the cluster. Default false (bool)

  • zone (pulumi.Input[str]) - Zone GKE cluster (string)

The rke_config object supports the following:

  • addonJobTimeout (pulumi.Input[float]) - Duration in seconds of addon job (int)

  • addons (pulumi.Input[str]) - Addons descripton to deploy on RKE cluster.

  • addonsIncludes (pulumi.Input[list]) - Addons yaml manifests to deploy on RKE cluster (list)

  • authentication (pulumi.Input[dict]) - Kubernetes cluster authentication (list maxitems:1)

    • sans (pulumi.Input[list]) - RKE sans for authentication ([]string)

    • strategy (pulumi.Input[str]) - RKE strategy for authentication (string)

  • authorization (pulumi.Input[dict]) - Kubernetes cluster authorization (list maxitems:1)

    • mode (pulumi.Input[str]) - RKE mode for authorization. rbac and none modes are available. Default rbac (string)

    • options (pulumi.Input[dict]) - RKE options for network (map)

  • bastionHost (pulumi.Input[dict]) - RKE bastion host (list maxitems:1)

    • address (pulumi.Input[str]) - Address ip for node (string)

    • port (pulumi.Input[str]) - Port for node. Default 22 (string)

    • sshAgentAuth (pulumi.Input[bool]) - Use ssh agent auth. Default false (bool)

    • sshKey (pulumi.Input[str]) - Node SSH private key (string)

    • sshKeyPath (pulumi.Input[str]) - Node SSH private key path (string)

    • user (pulumi.Input[str]) - Registry user (string)

  • cloudProvider (pulumi.Input[dict]) - RKE options for Calico network provider (string)

    • awsCloudProvider (pulumi.Input[dict]) - RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)

      • global (pulumi.Input[dict]) - (list maxitems:1)

        • disableSecurityGroupIngress (pulumi.Input[bool]) - Default false (bool)

        • disableStrictZoneCheck (pulumi.Input[bool]) - Default false (bool)

        • elbSecurityGroup (pulumi.Input[str]) - (string)

        • kubernetesClusterId (pulumi.Input[str]) - (string)

        • kubernetesClusterTag (pulumi.Input[str]) - (string)

        • roleArn (pulumi.Input[str]) - (string)

        • routeTableId (pulumi.Input[str]) - (string)

        • subnetId (pulumi.Input[str]) - (string)

        • vpc (pulumi.Input[str]) - (string)

        • zone (pulumi.Input[str]) - Zone GKE cluster (string)

      • serviceOverrides (pulumi.Input[list]) - (list)

        • region (pulumi.Input[str]) - The AWS Region to create the EKS cluster in. Default us-west-2 (string)

        • service (pulumi.Input[str]) - (string)

        • signingMethod (pulumi.Input[str]) - (string)

        • signingName (pulumi.Input[str]) - (string)

        • signingRegion (pulumi.Input[str]) - (string)

        • url (pulumi.Input[str]) - Registry URL (string)

    • azureCloudProvider (pulumi.Input[dict]) - RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)

      • aadClientCertPassword (pulumi.Input[str]) - (string)

      • aadClientCertPath (pulumi.Input[str]) - (string)

      • aadClientId (pulumi.Input[str]) - (string)

      • aadClientSecret (pulumi.Input[str]) - (string)

      • cloud (pulumi.Input[str]) - (string)

      • cloudProviderBackoff (pulumi.Input[bool]) - (bool)

      • cloudProviderBackoffDuration (pulumi.Input[float]) - (int)

      • cloudProviderBackoffExponent (pulumi.Input[float]) - (int)

      • cloudProviderBackoffJitter (pulumi.Input[float]) - (int)

      • cloudProviderBackoffRetries (pulumi.Input[float]) - (int)

      • cloudProviderRateLimit (pulumi.Input[bool]) - (bool)

      • cloudProviderRateLimitBucket (pulumi.Input[float]) - (int)

      • cloudProviderRateLimitQps (pulumi.Input[float]) - (int)

      • location (pulumi.Input[str]) - Azure Kubernetes cluster location. Default eastus (string)

      • maximumLoadBalancerRuleCount (pulumi.Input[float]) - (int)

      • primaryAvailabilitySetName (pulumi.Input[str]) - (string)

      • primaryScaleSetName (pulumi.Input[str]) - (string)

      • resourceGroup (pulumi.Input[str]) - The name of the Cluster resource group (string)

      • routeTableName (pulumi.Input[str]) - (string)

      • securityGroupName (pulumi.Input[str]) - (string)

      • subnetName (pulumi.Input[str]) - (string)

      • subscriptionId (pulumi.Input[str]) - Subscription credentials which uniquely identify Microsoft Azure subscription (string)

      • tenant_id (pulumi.Input[str]) - Azure tenant ID to use (string)

      • useInstanceMetadata (pulumi.Input[bool]) - (bool)

      • useManagedIdentityExtension (pulumi.Input[bool]) - (bool)

      • vmType (pulumi.Input[str]) - (string)

      • vnetName (pulumi.Input[str]) - (string)

      • vnetResourceGroup (pulumi.Input[str]) - (string)

    • customCloudProvider (pulumi.Input[str]) - RKE Custom Cloud Provider config for Cloud Provider (string) (string)

    • name (pulumi.Input[str]) - Name of cluster registration token (string)

    • openstackCloudProvider (pulumi.Input[dict]) - RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)

      • blockStorage (pulumi.Input[dict]) - (list maxitems:1)

        • bsVersion (pulumi.Input[str]) - (string)

        • ignoreVolumeAz (pulumi.Input[bool]) - (string)

        • trustDevicePath (pulumi.Input[bool]) - (string)

      • global (pulumi.Input[dict]) - (list maxitems:1)

        • authUrl (pulumi.Input[str]) - (string)

        • caFile (pulumi.Input[str]) - (string)

        • domainId (pulumi.Input[str]) - Required if domain_name not provided. (string)

        • domainName (pulumi.Input[str]) - Required if domain_id not provided. (string)

        • password (pulumi.Input[str]) - Registry password (string)

        • region (pulumi.Input[str]) - The AWS Region to create the EKS cluster in. Default us-west-2 (string)

        • tenant_id (pulumi.Input[str]) - Azure tenant ID to use (string)

        • tenantName (pulumi.Input[str]) - Required if tenant_id not provided. (string)

        • trustId (pulumi.Input[str]) - (string)

        • username (pulumi.Input[str]) - (string)

      • loadBalancer (pulumi.Input[dict]) - (list maxitems:1)

        • createMonitor (pulumi.Input[bool]) - (bool)

        • floatingNetworkId (pulumi.Input[str]) - (string)

        • lbMethod (pulumi.Input[str]) - (string)

        • lbProvider (pulumi.Input[str]) - (string)

        • lbVersion (pulumi.Input[str]) - (string)

        • manageSecurityGroups (pulumi.Input[bool]) - (bool)

        • monitorDelay (pulumi.Input[str]) - Default 60s (string)

        • monitorMaxRetries (pulumi.Input[float]) - Default 5 (int)

        • monitorTimeout (pulumi.Input[str]) - Default 30s (string)

        • subnetId (pulumi.Input[str]) - (string)

        • useOctavia (pulumi.Input[bool]) - (bool)

      • metadata (pulumi.Input[dict]) - (list maxitems:1)

        • requestTimeout (pulumi.Input[float]) - (int)

        • searchOrder (pulumi.Input[str]) - (string)

      • route (pulumi.Input[dict]) - (list maxitems:1)

        • routerId (pulumi.Input[str]) - (string)

    • vsphereCloudProvider (pulumi.Input[dict]) - RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument name is required on virtual_center configuration. (list maxitems:1)

      • disk (pulumi.Input[dict]) - (list maxitems:1)

        • scsiControllerType (pulumi.Input[str]) - (string)

      • global (pulumi.Input[dict]) - (list maxitems:1)

        • datacenters (pulumi.Input[str]) - (string)

        • insecureFlag (pulumi.Input[bool]) - (bool)

        • password (pulumi.Input[str]) - Registry password (string)

        • port (pulumi.Input[str]) - Port for node. Default 22 (string)

        • soapRoundtripCount (pulumi.Input[float]) - (int)

        • user (pulumi.Input[str]) - Registry user (string)

      • network (pulumi.Input[dict]) - Network for GKE cluster (string)

        • publicNetwork (pulumi.Input[str]) - (string)

      • virtualCenters (pulumi.Input[list]) - (List)

        • datacenters (pulumi.Input[str]) - (string)

        • name (pulumi.Input[str]) - Name of cluster registration token (string)

        • password (pulumi.Input[str]) - Registry password (string)

        • port (pulumi.Input[str]) - Port for node. Default 22 (string)

        • soapRoundtripCount (pulumi.Input[float]) - (int)

        • user (pulumi.Input[str]) - Registry user (string)

      • workspace (pulumi.Input[dict]) - (list maxitems:1)

        • datacenter (pulumi.Input[str]) - (string)

        • defaultDatastore (pulumi.Input[str]) - (string)

        • folder (pulumi.Input[str]) - Folder for S3 service. Available from Rancher v2.2.7 (string)

        • resourcepoolPath (pulumi.Input[str]) - (string)

        • server (pulumi.Input[str]) - (string)

  • dns (pulumi.Input[dict]) - RKE dns add-on. Just for Rancher v2.2.x (list maxitems:1)

    • nodeSelector (pulumi.Input[dict]) - Node selector for RKE Ingress (map)

    • provider (pulumi.Input[str]) - Provider for RKE monitoring (string)

    • reverseCidrs (pulumi.Input[list]) - DNS add-on reverse cidr (list)

    • upstreamNameservers (pulumi.Input[list]) - DNS add-on upstream nameservers (list)

  • ignoreDockerVersion (pulumi.Input[bool]) - Ignore docker version. Default true (bool)

  • ingress (pulumi.Input[dict]) - Kubernetes ingress configuration (list maxitems:1)

    • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

    • nodeSelector (pulumi.Input[dict]) - Node selector for RKE Ingress (map)

    • options (pulumi.Input[dict]) - RKE options for network (map)

    • provider (pulumi.Input[str]) - Provider for RKE monitoring (string)

  • kubernetesVersion (pulumi.Input[str]) - The Kubernetes master version (string)

  • monitoring (pulumi.Input[dict]) - Kubernetes cluster monitoring (list maxitems:1)

    • options (pulumi.Input[dict]) - RKE options for network (map)

    • provider (pulumi.Input[str]) - Provider for RKE monitoring (string)

  • network (pulumi.Input[dict]) - Network for GKE cluster (string)

    • calicoNetworkProvider (pulumi.Input[dict]) - Calico provider config for RKE network (list maxitems:1)

      • cloudProvider (pulumi.Input[str]) - RKE options for Calico network provider (string)

    • canalNetworkProvider (pulumi.Input[dict]) - Canal provider config for RKE network (list maxitems:1)

      • iface (pulumi.Input[str]) - Iface config Flannel network provider (string)

    • flannelNetworkProvider (pulumi.Input[dict]) - Flannel provider config for RKE network (list maxitems:1)

      • iface (pulumi.Input[str]) - Iface config Flannel network provider (string)

    • options (pulumi.Input[dict]) - RKE options for network (map)

    • plugin (pulumi.Input[str]) - Plugin for RKE network. canal (default), flannel, calico and weave are supported. (string)

    • weaveNetworkProvider (pulumi.Input[dict]) - Weave provider config for RKE network (list maxitems:1)

      • password (pulumi.Input[str]) - Registry password (string)

  • nodes (pulumi.Input[list]) - RKE cluster nodes (list)

    • address (pulumi.Input[str]) - Address ip for node (string)

    • dockerSocket (pulumi.Input[str]) - Docker socket for node (string)

    • hostnameOverride (pulumi.Input[str]) - Hostname override for node (string)

    • internalAddress (pulumi.Input[str]) - Internal ip for node (string)

    • labels (pulumi.Input[dict]) - Labels for cluster registration token object (map)

    • nodeId (pulumi.Input[str]) - Id for the node (string)

    • port (pulumi.Input[str]) - Port for node. Default 22 (string)

    • roles (pulumi.Input[list]) - Roles for the node. controlplane, etcd and worker are supported. (list)

    • sshAgentAuth (pulumi.Input[bool]) - Use ssh agent auth. Default false (bool)

    • sshKey (pulumi.Input[str]) - Node SSH private key (string)

    • sshKeyPath (pulumi.Input[str]) - Node SSH private key path (string)

    • user (pulumi.Input[str]) - Registry user (string)

  • prefixPath (pulumi.Input[str]) - Prefix to customize Kubernetes path (string)

  • privateRegistries (pulumi.Input[list]) - private registries for docker images (list)

    • isDefault (pulumi.Input[bool]) - Set as default registry. Default false (bool)

    • password (pulumi.Input[str]) - Registry password (string)

    • url (pulumi.Input[str]) - Registry URL (string)

    • user (pulumi.Input[str]) - Registry user (string)

  • services (pulumi.Input[dict]) - Kubernetes cluster services (list maxitems:1)

    • etcd (pulumi.Input[dict]) - Etcd options for RKE services (list maxitems:1)

      • backup_config (pulumi.Input[dict]) - Backup options for etcd service. Just for Rancher v2.2.x (list maxitems:1)

        • enabled (pulumi.Input[bool]) - Enable the authorized cluster endpoint. Default true (bool)

        • intervalHours (pulumi.Input[float]) - Interval hours for etcd backup. Default 12 (int)

        • retention (pulumi.Input[float]) - Retention for etcd backup. Default 6 (int)

        • s3BackupConfig (pulumi.Input[dict]) - S3 config options for etcd backup (list maxitems:1)

          • access_key (pulumi.Input[str]) - The AWS Client ID to use (string)

          • bucketName (pulumi.Input[str]) - Bucket name for S3 service (string)

          • customCa (pulumi.Input[str]) - Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)

          • endpoint (pulumi.Input[str]) - Endpoint for S3 service (string)

          • folder (pulumi.Input[str]) - Folder for S3 service. Available from Rancher v2.2.7 (string)

          • region (pulumi.Input[str]) - The AWS Region to create the EKS cluster in. Default us-west-2 (string)

          • secret_key (pulumi.Input[str]) - The AWS Client Secret associated with the Client ID (string)

      • caCert (pulumi.Input[str]) - TLS CA certificate for etcd service (string)

      • cert (pulumi.Input[str]) - TLS certificate for etcd service (string)

      • creation (pulumi.Input[str]) - Creation option for etcd service (string)

      • externalUrls (pulumi.Input[list]) - External urls for etcd service (list)

      • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

      • extraBinds (pulumi.Input[list]) - Extra binds for scheduler service (list)

      • extraEnvs (pulumi.Input[list]) - Extra environment for scheduler service (list)

      • gid (pulumi.Input[float]) - Etcd service GID. Default: 0. For Rancher v2.3.x or above (int)

      • image (pulumi.Input[str]) - Docker image for scheduler service (string)

      • key (pulumi.Input[str]) - TLS key for etcd service (string)

      • path (pulumi.Input[str]) - Path for etcd service (string)

      • retention (pulumi.Input[str]) - Retention for etcd backup. Default 6 (int)

      • snapshot (pulumi.Input[bool]) - Snapshot option for etcd service (bool)

      • uid (pulumi.Input[float]) - Etcd service UID. Default: 0. For Rancher v2.3.x or above (int)

    • kubeApi (pulumi.Input[dict]) - Kube API options for RKE services (list maxitems:1)

      • alwaysPullImages (pulumi.Input[bool]) - Enable AlwaysPullImages Admission controller plugin. Rancher docs Default: false (bool)

      • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

      • extraBinds (pulumi.Input[list]) - Extra binds for scheduler service (list)

      • extraEnvs (pulumi.Input[list]) - Extra environment for scheduler service (list)

      • image (pulumi.Input[str]) - Docker image for scheduler service (string)

      • podSecurityPolicy (pulumi.Input[bool]) - Pod Security Policy option for kube API service. Default false (bool)

      • serviceClusterIpRange (pulumi.Input[str]) - Service Cluster ip Range option for kube controller service (string)

      • serviceNodePortRange (pulumi.Input[str]) - Service Node Port Range option for kube API service (string)

    • kubeController (pulumi.Input[dict]) - Kube Controller options for RKE services (list maxitems:1)

      • clusterCidr (pulumi.Input[str]) - Cluster CIDR option for kube controller service (string)

      • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

      • extraBinds (pulumi.Input[list]) - Extra binds for scheduler service (list)

      • extraEnvs (pulumi.Input[list]) - Extra environment for scheduler service (list)

      • image (pulumi.Input[str]) - Docker image for scheduler service (string)

      • serviceClusterIpRange (pulumi.Input[str]) - Service Cluster ip Range option for kube controller service (string)

    • kubelet (pulumi.Input[dict]) - Kubelet options for RKE services (list maxitems:1)

      • clusterDnsServer (pulumi.Input[str]) - Cluster DNS Server option for kubelet service (string)

      • clusterDomain (pulumi.Input[str]) - Cluster Domain option for kubelet service (string)

      • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

      • extraBinds (pulumi.Input[list]) - Extra binds for scheduler service (list)

      • extraEnvs (pulumi.Input[list]) - Extra environment for scheduler service (list)

      • failSwapOn (pulumi.Input[bool]) - Enable or disable failing when swap on is not supported (bool)

      • image (pulumi.Input[str]) - Docker image for scheduler service (string)

      • infraContainerImage (pulumi.Input[str]) - Infra container image for kubelet service (string)

    • kubeproxy (pulumi.Input[dict]) - Kubeproxy options for RKE services (list maxitems:1)

      • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

      • extraBinds (pulumi.Input[list]) - Extra binds for scheduler service (list)

      • extraEnvs (pulumi.Input[list]) - Extra environment for scheduler service (list)

      • image (pulumi.Input[str]) - Docker image for scheduler service (string)

    • scheduler (pulumi.Input[dict]) - Scheduler options for RKE services (list maxitems:1)

      • extraArgs (pulumi.Input[dict]) - Extra arguments for scheduler service (map)

      • extraBinds (pulumi.Input[list]) - Extra binds for scheduler service (list)

      • extraEnvs (pulumi.Input[list]) - Extra environment for scheduler service (list)

      • image (pulumi.Input[str]) - Docker image for scheduler service (string)

  • sshAgentAuth (pulumi.Input[bool]) - Use ssh agent auth. Default false (bool)

  • sshKeyPath (pulumi.Input[str]) - Node SSH private key path (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.ClusterAlterGroup(resource_name, opts=None, annotations=None, cluster_id=None, description=None, group_interval_seconds=None, group_wait_seconds=None, labels=None, name=None, recipients=None, repeat_interval_seconds=None, __props__=None, __name__=None, __opts__=None)

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

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – The cluster alert group annotations (map)

  • cluster_id (pulumi.Input[str]) – The cluster id where create cluster alert group (string)

  • description (pulumi.Input[str]) – The cluster alert group description (string)

  • group_interval_seconds (pulumi.Input[float]) – The cluster alert group interval seconds. Default: 180 (int)

  • group_wait_seconds (pulumi.Input[float]) – The cluster alert group wait seconds. Default: 180 (int)

  • labels (pulumi.Input[dict]) – The cluster alert group labels (map)

  • name (pulumi.Input[str]) – The cluster alert group name (string)

  • recipients (pulumi.Input[list]) – The cluster alert group recipients (list)

  • repeat_interval_seconds (pulumi.Input[float]) – The cluster alert group wait seconds. Default: 3600 (int)

The recipients object supports the following:

  • notifierId (pulumi.Input[str]) - Recipient notifier ID (string)

  • notifierType (pulumi.Input[str]) - Recipient notifier ID. Supported values : "pagerduty" | "slack" | "email" | "webhook" | "wechat" (string)

  • recipient (pulumi.Input[str]) - Recipient (string)

annotations = None

The cluster alert group annotations (map)

cluster_id = None

The cluster id where create cluster alert group (string)

description = None

The cluster alert group description (string)

group_interval_seconds = None

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

group_wait_seconds = None

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

labels = None

The cluster alert group labels (map)

name = None

The cluster alert group name (string)

recipients = None

The cluster alert group recipients (list)

  • notifierId (str) - Recipient notifier ID (string)

  • notifierType (str) - Recipient notifier ID. Supported values : "pagerduty" | "slack" | "email" | "webhook" | "wechat" (string)

  • recipient (str) - Recipient (string)

repeat_interval_seconds = None

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

static get(resource_name, id, opts=None, annotations=None, cluster_id=None, description=None, group_interval_seconds=None, group_wait_seconds=None, labels=None, name=None, recipients=None, repeat_interval_seconds=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – The cluster alert group annotations (map)

  • cluster_id (pulumi.Input[str]) – The cluster id where create cluster alert group (string)

  • description (pulumi.Input[str]) – The cluster alert group description (string)

  • group_interval_seconds (pulumi.Input[float]) – The cluster alert group interval seconds. Default: 180 (int)

  • group_wait_seconds (pulumi.Input[float]) – The cluster alert group wait seconds. Default: 180 (int)

  • labels (pulumi.Input[dict]) – The cluster alert group labels (map)

  • name (pulumi.Input[str]) – The cluster alert group name (string)

  • recipients (pulumi.Input[list]) – The cluster alert group recipients (list)

  • repeat_interval_seconds (pulumi.Input[float]) – The cluster alert group wait seconds. Default: 3600 (int)

The recipients object supports the following:

  • notifierId (pulumi.Input[str]) - Recipient notifier ID (string)

  • notifierType (pulumi.Input[str]) - Recipient notifier ID. Supported values : "pagerduty" | "slack" | "email" | "webhook" | "wechat" (string)

  • recipient (pulumi.Input[str]) - Recipient (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.ClusterAlterRule(resource_name, opts=None, annotations=None, cluster_id=None, event_rule=None, group_id=None, group_interval_seconds=None, group_wait_seconds=None, inherited=None, labels=None, metric_rule=None, name=None, node_rule=None, repeat_interval_seconds=None, severity=None, system_service_rule=None, __props__=None, __name__=None, __opts__=None)

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

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – The cluster alert rule annotations (map)

  • cluster_id (pulumi.Input[str]) – The cluster id where create cluster alert rule (string)

  • event_rule (pulumi.Input[dict]) – The cluster alert rule event rule. ConflictsWith: :raw-html-m2r:`<code class=”docutils literal”><span class=”pre”>”metric_rule”, “node_rule”, “system_service_rule”`` (list Maxitems:1)

  • group_id (pulumi.Input[str]) – The cluster alert rule alert group ID (string)

  • group_interval_seconds (pulumi.Input[float]) – The cluster alert rule group interval seconds. Default:</span></code>`180``(int)

  • group_wait_seconds (pulumi.Input[float]) – The cluster alert rule group wait seconds. Default:``180``(int)

  • inherited (pulumi.Input[bool]) – The cluster alert rule inherited. Default:``true``(bool)

  • labels (pulumi.Input[dict]) – The cluster alert rule labels (map)

  • metric_rule (pulumi.Input[dict]) – The cluster alert rule metric rule. ConflictsWith:``”event_rule”, “node_rule”, “system_service_rule”``(list Maxitems:1)

  • name (pulumi.Input[str]) – The cluster alert rule name (string)

  • node_rule (pulumi.Input[dict]) – The cluster alert rule node rule. ConflictsWith: “event_rule”, “metric_rule”, “system_service_rule”` (list Maxitems:1)

  • repeat_interval_seconds (pulumi.Input[float]) – The cluster alert rule wait seconds. Default: 3600 (int)

  • severity (pulumi.Input[str]) – The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

  • system_service_rule (pulumi.Input[dict]) – The cluster alert rule system service rule. ConflictsWith: “event_rule”, “metric_rule”, “node_rule”` (list Maxitems:1)

The event_rule object supports the following:

  • eventType (pulumi.Input[str]) - Event type. Supported values : "Warning" | "Normal". Default: Warning (string)

  • resourceKind (pulumi.Input[str]) - Resource kind. Supported values : "DaemonSet" | "Deployment" | "Node" | "Pod" | "StatefulSet" (string)

The metric_rule object supports the following:

  • comparison (pulumi.Input[str]) - Metric rule comparison. Supported values : "equal" | "greater-or-equal" | "greater-than" | "less-or-equal" | "less-than" | "not-equal" | "has-value". Default: equal (string)

  • description (pulumi.Input[str]) - Metric rule description (string)

  • duration (pulumi.Input[str]) - Metric rule duration (string)

  • expression (pulumi.Input[str]) - Metric rule expression (string)

  • thresholdValue (pulumi.Input[float]) - Metric rule threshold value (float64)

The node_rule object supports the following:

  • condition (pulumi.Input[str]) - System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

  • cpuThreshold (pulumi.Input[float]) - Node rule cpu threshold. Default: 70 (int)

  • memThreshold (pulumi.Input[float]) - Node rule mem threshold. Default: 70 (int)

  • nodeId (pulumi.Input[str]) - Node ID (string)

  • selector (pulumi.Input[dict]) - Node rule selector (map)

The system_service_rule object supports the following:

  • condition (pulumi.Input[str]) - System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

annotations = None

The cluster alert rule annotations (map)

cluster_id = None

The cluster id where create cluster alert rule (string)

event_rule = None

The cluster alert rule event rule. ConflictsWith: “metric_rule”, “node_rule”, “system_service_rule”` (list Maxitems:1)

  • eventType (str) - Event type. Supported values : "Warning" | "Normal". Default: Warning (string)

  • resourceKind (str) - Resource kind. Supported values : "DaemonSet" | "Deployment" | "Node" | "Pod" | "StatefulSet" (string)

group_id = None

The cluster alert rule alert group ID (string)

group_interval_seconds = None

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

group_wait_seconds = None

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

inherited = None

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

labels = None

The cluster alert rule labels (map)

metric_rule = None

The cluster alert rule metric rule. ConflictsWith: “event_rule”, “node_rule”, “system_service_rule”` (list Maxitems:1)

  • comparison (str) - Metric rule comparison. Supported values : "equal" | "greater-or-equal" | "greater-than" | "less-or-equal" | "less-than" | "not-equal" | "has-value". Default: equal (string)

  • description (str) - Metric rule description (string)

  • duration (str) - Metric rule duration (string)

  • expression (str) - Metric rule expression (string)

  • thresholdValue (float) - Metric rule threshold value (float64)

name = None

The cluster alert rule name (string)

node_rule = None

The cluster alert rule node rule. ConflictsWith: “event_rule”, “metric_rule”, “system_service_rule”` (list Maxitems:1)

  • condition (str) - System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

  • cpuThreshold (float) - Node rule cpu threshold. Default: 70 (int)

  • memThreshold (float) - Node rule mem threshold. Default: 70 (int)

  • nodeId (str) - Node ID (string)

  • selector (dict) - Node rule selector (map)

repeat_interval_seconds = None

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

severity = None

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

system_service_rule = None

The cluster alert rule system service rule. ConflictsWith: “event_rule”, “metric_rule”, “node_rule”` (list Maxitems:1)

  • condition (str) - System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

static get(resource_name, id, opts=None, annotations=None, cluster_id=None, event_rule=None, group_id=None, group_interval_seconds=None, group_wait_seconds=None, inherited=None, labels=None, metric_rule=None, name=None, node_rule=None, repeat_interval_seconds=None, severity=None, system_service_rule=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – The cluster alert rule annotations (map)

  • cluster_id (pulumi.Input[str]) – The cluster id where create cluster alert rule (string)

  • event_rule (pulumi.Input[dict]) – The cluster alert rule event rule. ConflictsWith: :raw-html-m2r:`<code class=”docutils literal”><span class=”pre”>”metric_rule”, “node_rule”, “system_service_rule”`` (list Maxitems:1)

  • group_id (pulumi.Input[str]) – The cluster alert rule alert group ID (string)

  • group_interval_seconds (pulumi.Input[float]) – The cluster alert rule group interval seconds. Default:</span></code>`180``(int)

  • group_wait_seconds (pulumi.Input[float]) – The cluster alert rule group wait seconds. Default:``180``(int)

  • inherited (pulumi.Input[bool]) – The cluster alert rule inherited. Default:``true``(bool)

  • labels (pulumi.Input[dict]) – The cluster alert rule labels (map)

  • metric_rule (pulumi.Input[dict]) – The cluster alert rule metric rule. ConflictsWith:``”event_rule”, “node_rule”, “system_service_rule”``(list Maxitems:1)

  • name (pulumi.Input[str]) – The cluster alert rule name (string)

  • node_rule (pulumi.Input[dict]) – The cluster alert rule node rule. ConflictsWith: “event_rule”, “metric_rule”, “system_service_rule”` (list Maxitems:1)

  • repeat_interval_seconds (pulumi.Input[float]) – The cluster alert rule wait seconds. Default: 3600 (int)

  • severity (pulumi.Input[str]) – The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

  • system_service_rule (pulumi.Input[dict]) – The cluster alert rule system service rule. ConflictsWith: “event_rule”, “metric_rule”, “node_rule”` (list Maxitems:1)

The event_rule object supports the following:

  • eventType (pulumi.Input[str]) - Event type. Supported values : "Warning" | "Normal". Default: Warning (string)

  • resourceKind (pulumi.Input[str]) - Resource kind. Supported values : "DaemonSet" | "Deployment" | "Node" | "Pod" | "StatefulSet" (string)

The metric_rule object supports the following:

  • comparison (pulumi.Input[str]) - Metric rule comparison. Supported values : "equal" | "greater-or-equal" | "greater-than" | "less-or-equal" | "less-than" | "not-equal" | "has-value". Default: equal (string)

  • description (pulumi.Input[str]) - Metric rule description (string)

  • duration (pulumi.Input[str]) - Metric rule duration (string)

  • expression (pulumi.Input[str]) - Metric rule expression (string)

  • thresholdValue (pulumi.Input[float]) - Metric rule threshold value (float64)

The node_rule object supports the following:

  • condition (pulumi.Input[str]) - System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

  • cpuThreshold (pulumi.Input[float]) - Node rule cpu threshold. Default: 70 (int)

  • memThreshold (pulumi.Input[float]) - Node rule mem threshold. Default: 70 (int)

  • nodeId (pulumi.Input[str]) - Node ID (string)

  • selector (pulumi.Input[dict]) - Node rule selector (map)

The system_service_rule object supports the following:

  • condition (pulumi.Input[str]) - System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.ClusterDriver(resource_name, opts=None, active=None, actual_url=None, annotations=None, builtin=None, checksum=None, labels=None, name=None, ui_url=None, url=None, whitelist_domains=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • active (pulumi.Input[bool]) – Specify the cluster driver state (bool)

  • actual_url (pulumi.Input[str]) – Actual url of the cluster driver (string)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • builtin (pulumi.Input[bool]) – Specify whether the cluster driver is an internal cluster driver or not (bool)

  • checksum (pulumi.Input[str]) – Verify that the downloaded driver matches the expected checksum (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • name (pulumi.Input[str]) – Name of the cluster driver (string)

  • ui_url (pulumi.Input[str]) – The URL to load for customized Add Clusters screen for this driver (string)

  • url (pulumi.Input[str]) – The URL to download the machine driver binary for 64-bit Linux (string)

  • whitelist_domains (pulumi.Input[list]) – Domains to whitelist for the ui (list)

active = None

Specify the cluster driver state (bool)

actual_url = None

Actual url of the cluster driver (string)

annotations = None

Annotations of the resource (map)

builtin = None

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

checksum = None

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

labels = None

Labels of the resource (map)

name = None

Name of the cluster driver (string)

ui_url = None

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

url = None

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

whitelist_domains = None

Domains to whitelist for the ui (list)

static get(resource_name, id, opts=None, active=None, actual_url=None, annotations=None, builtin=None, checksum=None, labels=None, name=None, ui_url=None, url=None, whitelist_domains=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • active (pulumi.Input[bool]) – Specify the cluster driver state (bool)

  • actual_url (pulumi.Input[str]) – Actual url of the cluster driver (string)

  • annotations (pulumi.Input[dict]) – Annotations of the resource (map)

  • builtin (pulumi.Input[bool]) – Specify whether the cluster driver is an internal cluster driver or not (bool)

  • checksum (pulumi.Input[str]) – Verify that the downloaded driver matches the expected checksum (string)

  • labels (pulumi.Input[dict]) – Labels of the resource (map)

  • name (pulumi.Input[str]) – Name of the cluster driver (string)

  • ui_url (pulumi.Input[str]) – The URL to load for customized Add Clusters screen for this driver (string)

  • url (pulumi.Input[str]) – The URL to download the machine driver binary for 64-bit Linux (string)

  • whitelist_domains (pulumi.Input[list]) – Domains to whitelist for the ui (list)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.ClusterLogging(resource_name, opts=None, annotations=None, cluster_id=None, elasticsearch_config=None, fluentd_config=None, kafka_config=None, kind=None, labels=None, name=None, namespace_id=None, output_flush_interval=None, output_tags=None, splunk_config=None, syslog_config=None, __props__=None, __name__=None, __opts__=None)

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

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for Cluster Logging object (map)

  • cluster_id (pulumi.Input[str]) – The cluster id to configure logging (string)

  • elasticsearch_config (pulumi.Input[dict]) – The elasticsearch config for Cluster Logging. For kind = elasticsearch. Conflicts with fluentd_config, kafka_config, splunk_config and syslog_config (list maxitems:1)

  • fluentd_config (pulumi.Input[dict]) – The fluentd config for Cluster Logging. For kind = fluentd. Conflicts with elasticsearch_config, kafka_config, splunk_config and syslog_config (list maxitems:1)

  • kafka_config (pulumi.Input[dict]) – The kafka config for Cluster Logging. For kind = kafka. Conflicts with elasticsearch_config, fluentd_config, splunk_config and syslog_config (list maxitems:1)

  • kind (pulumi.Input[str]) – The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

  • labels (pulumi.Input[dict]) – Labels for Cluster Logging object (map)

  • name (pulumi.Input[str]) – The name of the cluster logging config (string)

  • namespace_id (pulumi.Input[str]) – The namespace id from cluster logging (string)

  • output_flush_interval (pulumi.Input[float]) – How often buffered logs would be flushed. Default: 3 seconds (int)

  • output_tags (pulumi.Input[dict]) – The output tags for Cluster Logging (map)

  • splunk_config (pulumi.Input[dict]) – The splunk config for Cluster Logging. For kind = splunk. Conflicts with elasticsearch_config, fluentd_config, kafka_config, and syslog_config (list maxitems:1)

  • syslog_config (pulumi.Input[dict]) – The syslog config for Cluster Logging. For kind = syslog. Conflicts with elasticsearch_config, fluentd_config, kafka_config, and splunk_config (list maxitems:1)

The elasticsearch_config object supports the following:

  • authPassword (pulumi.Input[str]) - User password for the elascticsearch service (string)

  • authUsername (pulumi.Input[str]) - Username for the elascticsearch service (string)

  • certificate (pulumi.Input[str]) - SSL certificate for the syslog service (string)

  • clientCert (pulumi.Input[str]) - SSL client certificate for the syslog service (string)

  • clientKey (pulumi.Input[str]) - SSL client key for the syslog service (string)

  • clientKeyPass (pulumi.Input[str]) - SSL client key password for the splunk service (string)

  • dateFormat (pulumi.Input[str]) - Date format for the elascticsearch logs. Default: YYYY-MM-DD (string)

  • endpoint (pulumi.Input[str]) - Endpoint of the syslog service (string)

  • indexPrefix (pulumi.Input[str]) - Index prefix for the elascticsearch logs. Default: local (string)

  • sslVerify (pulumi.Input[bool]) - SSL verify for the syslog service (bool)

  • sslVersion (pulumi.Input[str]) - SSL version for the elascticsearch service (string)

The fluentd_config object supports the following:

  • certificate (pulumi.Input[str]) - SSL certificate for the syslog service (string)

  • compress (pulumi.Input[bool]) - Compress data for the fluentd service (bool)

  • enableTls (pulumi.Input[bool]) - Enable TLS for the fluentd service (bool)

  • fluentServers (pulumi.Input[list]) - Servers for the fluentd service (list)

    • endpoint (pulumi.Input[str]) - Endpoint of the syslog service (string)

    • hostname (pulumi.Input[str]) - Hostname of the fluentd service (string)

    • password (pulumi.Input[str]) - User password of the fluentd service (string)

    • sharedKey (pulumi.Input[str]) - Shared key of the fluentd service (string)

    • standby (pulumi.Input[bool]) - Standby server of the fluentd service (bool)

    • username (pulumi.Input[str]) - Username of the fluentd service (string)

    • weight (pulumi.Input[float]) - Weight of the fluentd server (int)

The kafka_config object supports the following:

  • brokerEndpoints (pulumi.Input[list]) - Kafka endpoints for kafka service. Conflicts with zookeeper_endpoint (list)

  • certificate (pulumi.Input[str]) - SSL certificate for the syslog service (string)

  • clientCert (pulumi.Input[str]) - SSL client certificate for the syslog service (string)

  • clientKey (pulumi.Input[str]) - SSL client key for the syslog service (string)

  • topic (pulumi.Input[str]) - Topic to publish on the kafka service (string)

  • zookeeperEndpoint (pulumi.Input[str]) - Zookeeper endpoint for kafka service. Conflicts with broker_endpoints (string)

The splunk_config object supports the following:

  • certificate (pulumi.Input[str]) - SSL certificate for the syslog service (string)

  • clientCert (pulumi.Input[str]) - SSL client certificate for the syslog service (string)

  • clientKey (pulumi.Input[str]) - SSL client key for the syslog service (string)

  • clientKeyPass (pulumi.Input[str]) - SSL client key password for the splunk service (string)

  • endpoint (pulumi.Input[str]) - Endpoint of the syslog service (string)

  • index (pulumi.Input[str]) - Index prefix for the splunk logs (string)

  • source (pulumi.Input[str]) - Date format for the splunk logs (string)

  • sslVerify (pulumi.Input[bool]) - SSL verify for the syslog service (bool)

  • token (pulumi.Input[str]) - Token for the syslog service (string)

The syslog_config object supports the following:

  • certificate (pulumi.Input[str]) - SSL certificate for the syslog service (string)

  • clientCert (pulumi.Input[str]) - SSL client certificate for the syslog service (string)

  • clientKey (pulumi.Input[str]) - SSL client key for the syslog service (string)

  • endpoint (pulumi.Input[str]) - Endpoint of the syslog service (string)

  • program (pulumi.Input[str]) - Program for the syslog service (string)

  • protocol (pulumi.Input[str]) - Protocol for the syslog service. tcp and udp are supported. Default: udp (string)

  • severity (pulumi.Input[str]) - Date format for the syslog logs. emergency, alert, critical, error, warning, notice, info and debug are supported. Default: notice (string)

  • sslVerify (pulumi.Input[bool]) - SSL verify for the syslog service (bool)

  • token (pulumi.Input[str]) - Token for the syslog service (string)

annotations = None

Annotations for Cluster Logging object (map)

cluster_id = None

The cluster id to configure logging (string)

elasticsearch_config = None

The elasticsearch config for Cluster Logging. For kind = elasticsearch. Conflicts with fluentd_config, kafka_config, splunk_config and syslog_config (list maxitems:1)

  • authPassword (str) - User password for the elascticsearch service (string)

  • authUsername (str) - Username for the elascticsearch service (string)

  • certificate (str) - SSL certificate for the syslog service (string)

  • clientCert (str) - SSL client certificate for the syslog service (string)

  • clientKey (str) - SSL client key for the syslog service (string)

  • clientKeyPass (str) - SSL client key password for the splunk service (string)

  • dateFormat (str) - Date format for the elascticsearch logs. Default: YYYY-MM-DD (string)

  • endpoint (str) - Endpoint of the syslog service (string)

  • indexPrefix (str) - Index prefix for the elascticsearch logs. Default: local (string)

  • sslVerify (bool) - SSL verify for the syslog service (bool)

  • sslVersion (str) - SSL version for the elascticsearch service (string)

fluentd_config = None

The fluentd config for Cluster Logging. For kind = fluentd. Conflicts with elasticsearch_config, kafka_config, splunk_config and syslog_config (list maxitems:1)

  • certificate (str) - SSL certificate for the syslog service (string)

  • compress (bool) - Compress data for the fluentd service (bool)

  • enableTls (bool) - Enable TLS for the fluentd service (bool)

  • fluentServers (list) - Servers for the fluentd service (list)

    • endpoint (str) - Endpoint of the syslog service (string)

    • hostname (str) - Hostname of the fluentd service (string)

    • password (str) - User password of the fluentd service (string)

    • sharedKey (str) - Shared key of the fluentd service (string)

    • standby (bool) - Standby server of the fluentd service (bool)

    • username (str) - Username of the fluentd service (string)

    • weight (float) - Weight of the fluentd server (int)

kafka_config = None

The kafka config for Cluster Logging. For kind = kafka. Conflicts with elasticsearch_config, fluentd_config, splunk_config and syslog_config (list maxitems:1)

  • brokerEndpoints (list) - Kafka endpoints for kafka service. Conflicts with zookeeper_endpoint (list)

  • certificate (str) - SSL certificate for the syslog service (string)

  • clientCert (str) - SSL client certificate for the syslog service (string)

  • clientKey (str) - SSL client key for the syslog service (string)

  • topic (str) - Topic to publish on the kafka service (string)

  • zookeeperEndpoint (str) - Zookeeper endpoint for kafka service. Conflicts with broker_endpoints (string)

kind = None

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

labels = None

Labels for Cluster Logging object (map)

name = None

The name of the cluster logging config (string)

namespace_id = None

The namespace id from cluster logging (string)

output_flush_interval = None

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

output_tags = None

The output tags for Cluster Logging (map)

splunk_config = None

The splunk config for Cluster Logging. For kind = splunk. Conflicts with elasticsearch_config, fluentd_config, kafka_config, and syslog_config (list maxitems:1)

  • certificate (str) - SSL certificate for the syslog service (string)

  • clientCert (str) - SSL client certificate for the syslog service (string)

  • clientKey (str) - SSL client key for the syslog service (string)

  • clientKeyPass (str) - SSL client key password for the splunk service (string)

  • endpoint (str) - Endpoint of the syslog service (string)

  • index (str) - Index prefix for the splunk logs (string)

  • source (str) - Date format for the splunk logs (string)

  • sslVerify (bool) - SSL verify for the syslog service (bool)

  • token (str) - Token for the syslog service (string)

syslog_config = None

The syslog config for Cluster Logging. For kind = syslog. Conflicts with elasticsearch_config, fluentd_config, kafka_config, and splunk_config (list maxitems:1)

  • certificate (str) - SSL certificate for the syslog service (string)

  • clientCert (str) - SSL client certificate for the syslog service (string)

  • clientKey (str) - SSL client key for the syslog service (string)

  • endpoint (str) - Endpoint of the syslog service (string)

  • program (str) - Program for the syslog service (string)

  • protocol (str) - Protocol for the syslog service. tcp and udp are supported. Default: udp (string)

  • severity (str) - Date format for the syslog logs. emergency, alert, critical, error, warning, notice, info and debug are supported. Default: notice (string)

  • sslVerify (bool) - SSL verify for the syslog service (bool)

  • token (str) - Token for the syslog service (string)

static get(resource_name, id, opts=None, annotations=None, cluster_id=None, elasticsearch_config=None, fluentd_config=None, kafka_config=None, kind=None, labels=None, name=None, namespace_id=None, output_flush_interval=None, output_tags=None, splunk_config=None, syslog_config=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for Cluster Logging object (map)

  • cluster_id (pulumi.Input[str]) – The cluster id to configure logging (string)

  • elasticsearch_config (pulumi.Input[dict]) – The elasticsearch config for Cluster Logging. For kind = elasticsearch. Conflicts with fluentd_config, kafka_config, splunk_config and syslog_config (list maxitems:1)

  • fluentd_config (pulumi.Input[dict]) – The fluentd config for Cluster Logging. For kind = fluentd. Conflicts with elasticsearch_config, kafka_config, splunk_config and syslog_config (list maxitems:1)

  • kafka_config (pulumi.Input[dict]) – The kafka config for Cluster Logging. For kind = kafka. Conflicts with elasticsearch_config, fluentd_config, splunk_config and syslog_config (list maxitems:1)

  • kind (pulumi.Input[str]) – The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

  • labels (pulumi.Input[dict]) – Labels for Cluster Logging object (map)

  • name (pulumi.Input[str]) – The name of the cluster logging config (string)

  • namespace_id (pulumi.Input[str]) – The namespace id from cluster logging (string)

  • output_flush_interval (pulumi.Input[float]) – How often buffered logs would be flushed. Default: 3 seconds (int)

  • output_tags (pulumi.Input[dict]) – The output tags for Cluster Logging (map)

  • splunk_config (pulumi.Input[dict]) – The splunk config for Cluster Logging. For kind = splunk. Conflicts with elasticsearch_config, fluentd_config, kafka_config, and syslog_config (list maxitems:1)

  • syslog_config (pulumi.Input[dict]) – The syslog config for Cluster Logging. For kind = syslog. Conflicts with elasticsearch_config, fluentd_config, kafka_config, and splunk_config (list maxitems:1)

The elasticsearch_config object supports the following:

  • authPassword (pulumi.Input[str]) - User password for the elascticsearch service (string)

  • authUsername (pulumi.Input[str]) - Username for the elascticsearch service (string)

  • certificate (pulumi.Input[str]) - SSL certificate for the syslog service (string)

  • clientCert (pulumi.Input[str]) - SSL client certificate for the syslog service (string)

  • clientKey (pulumi.Input[str]) - SSL client key for the syslog service (string)

  • clientKeyPass (pulumi.Input[str]) - SSL client key password for the splunk service (string)

  • dateFormat (pulumi.Input[str]) - Date format for the elascticsearch logs. Default: YYYY-MM-DD (string)

  • endpoint (pulumi.Input[str]) - Endpoint of the syslog service (string)

  • indexPrefix (pulumi.Input[str]) - Index prefix for the elascticsearch logs. Default: local (string)

  • sslVerify (pulumi.Input[bool]) - SSL verify for the syslog service (bool)

  • sslVersion (pulumi.Input[str]) - SSL version for the elascticsearch service (string)

The fluentd_config object supports the following:

  • certificate (pulumi.Input[str]) - SSL certificate for the syslog service (string)

  • compress (pulumi.Input[bool]) - Compress data for the fluentd service (bool)

  • enableTls (pulumi.Input[bool]) - Enable TLS for the fluentd service (bool)

  • fluentServers (pulumi.Input[list]) - Servers for the fluentd service (list)

    • endpoint (pulumi.Input[str]) - Endpoint of the syslog service (string)

    • hostname (pulumi.Input[str]) - Hostname of the fluentd service (string)

    • password (pulumi.Input[str]) - User password of the fluentd service (string)

    • sharedKey (pulumi.Input[str]) - Shared key of the fluentd service (string)

    • standby (pulumi.Input[bool]) - Standby server of the fluentd service (bool)

    • username (pulumi.Input[str]) - Username of the fluentd service (string)

    • weight (pulumi.Input[float]) - Weight of the fluentd server (int)

The kafka_config object supports the following:

  • brokerEndpoints (pulumi.Input[list]) - Kafka endpoints for kafka service. Conflicts with zookeeper_endpoint (list)

  • certificate (pulumi.Input[str]) - SSL certificate for the syslog service (string)

  • clientCert (pulumi.Input[str]) - SSL client certificate for the syslog service (string)

  • clientKey (pulumi.Input[str]) - SSL client key for the syslog service (string)

  • topic (pulumi.Input[str]) - Topic to publish on the kafka service (string)

  • zookeeperEndpoint (pulumi.Input[str]) - Zookeeper endpoint for kafka service. Conflicts with broker_endpoints (string)

The splunk_config object supports the following:

  • certificate (pulumi.Input[str]) - SSL certificate for the syslog service (string)

  • clientCert (pulumi.Input[str]) - SSL client certificate for the syslog service (string)

  • clientKey (pulumi.Input[str]) - SSL client key for the syslog service (string)

  • clientKeyPass (pulumi.Input[str]) - SSL client key password for the splunk service (string)

  • endpoint (pulumi.Input[str]) - Endpoint of the syslog service (string)

  • index (pulumi.Input[str]) - Index prefix for the splunk logs (string)

  • source (pulumi.Input[str]) - Date format for the splunk logs (string)

  • sslVerify (pulumi.Input[bool]) - SSL verify for the syslog service (bool)

  • token (pulumi.Input[str]) - Token for the syslog service (string)

The syslog_config object supports the following:

  • certificate (pulumi.Input[str]) - SSL certificate for the syslog service (string)

  • clientCert (pulumi.Input[str]) - SSL client certificate for the syslog service (string)

  • clientKey (pulumi.Input[str]) - SSL client key for the syslog service (string)

  • endpoint (pulumi.Input[str]) - Endpoint of the syslog service (string)

  • program (pulumi.Input[str]) - Program for the syslog service (string)

  • protocol (pulumi.Input[str]) - Protocol for the syslog service. tcp and udp are supported. Default: udp (string)

  • severity (pulumi.Input[str]) - Date format for the syslog logs. emergency, alert, critical, error, warning, notice, info and debug are supported. Default: notice (string)

  • sslVerify (pulumi.Input[bool]) - SSL verify for the syslog service (bool)

  • token (pulumi.Input[str]) - Token for the syslog service (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.ClusterRoleTemplateBinding(resource_name, opts=None, annotations=None, cluster_id=None, group_id=None, group_principal_id=None, labels=None, name=None, role_template_id=None, user_id=None, user_principal_id=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for cluster role template binding (map)

  • cluster_id (pulumi.Input[str]) – The cluster id where bind cluster role template binding (string)

  • group_id (pulumi.Input[str]) – The group ID to assign cluster role template binding (string)

  • group_principal_id (pulumi.Input[str]) – The group_principal ID to assign cluster role template binding (string)

  • labels (pulumi.Input[dict]) – Labels for cluster role template binding (map)

  • name (pulumi.Input[str]) – The name of the cluster role template binding (string)

  • role_template_id (pulumi.Input[str]) – The role template id from create cluster role template binding (string)

  • user_id (pulumi.Input[str]) – The user ID to assign cluster role template binding (string)

  • user_principal_id (pulumi.Input[str]) – The user_principal ID to assign cluster role template binding (string)

annotations = None

Annotations for cluster role template binding (map)

cluster_id = None

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

group_id = None

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

group_principal_id = None

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

labels = None

Labels for cluster role template binding (map)

name = None

The name of the cluster role template binding (string)

role_template_id = None

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

user_id = None

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

user_principal_id = None

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

static get(resource_name, id, opts=None, annotations=None, cluster_id=None, group_id=None, group_principal_id=None, labels=None, name=None, role_template_id=None, user_id=None, user_principal_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for cluster role template binding (map)

  • cluster_id (pulumi.Input[str]) – The cluster id where bind cluster role template binding (string)

  • group_id (pulumi.Input[str]) – The group ID to assign cluster role template binding (string)

  • group_principal_id (pulumi.Input[str]) – The group_principal ID to assign cluster role template binding (string)

  • labels (pulumi.Input[dict]) – Labels for cluster role template binding (map)

  • name (pulumi.Input[str]) – The name of the cluster role template binding (string)

  • role_template_id (pulumi.Input[str]) – The role template id from create cluster role template binding (string)

  • user_id (pulumi.Input[str]) – The user ID to assign cluster role template binding (string)

  • user_principal_id (pulumi.Input[str]) – The user_principal ID to assign cluster role template binding (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.ClusterSync(resource_name, opts=None, cluster_id=None, node_pool_ids=None, synced=None, __props__=None, __name__=None, __opts__=None)

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

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_id (pulumi.Input[str]) – The cluster ID that is syncing (string)

  • node_pool_ids (pulumi.Input[list]) – The node pool IDs used by the cluster id (list)

cluster_id = None

The cluster ID that is syncing (string)

default_project_id = None

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

kube_config = None

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

node_pool_ids = None

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

system_project_id = None

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

static get(resource_name, id, opts=None, cluster_id=None, default_project_id=None, kube_config=None, node_pool_ids=None, synced=None, system_project_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_id (pulumi.Input[str]) – The cluster ID that is syncing (string)

  • default_project_id (pulumi.Input[str]) – (Computed) Default project ID for the cluster sync (string)

  • kube_config (pulumi.Input[str]) – (Computed) Kube Config generated for the cluster sync (string)

  • node_pool_ids (pulumi.Input[list]) – The node pool IDs used by the cluster id (list)

  • system_project_id (pulumi.Input[str]) – (Computed) System project ID for the cluster sync (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.ClusterTemplate(resource_name, opts=None, annotations=None, description=None, labels=None, members=None, name=None, template_revisions=None, __props__=None, __name__=None, __opts__=None)

Provides a Rancher v2 Cluster Template resource. This can be used to create Cluster Templates for Rancher v2 RKE clusters and retrieve their information.

Cluster Templates are available from Rancher v2.3.x and above.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for the cluster template revision (map)

  • labels (pulumi.Input[dict]) – Labels for the cluster template revision (map)

  • members (pulumi.Input[list]) – Cluster template members (list)

  • name (pulumi.Input[str]) – The cluster template revision name (string)

  • template_revisions (pulumi.Input[list]) – Cluster template revisions (list)

The members object supports the following:

  • accessType (pulumi.Input[str]) - Member access type. Valid values: ["read-only" | "owner"] (string)

  • group_principal_id (pulumi.Input[str]) - Member group principal id (string)

  • user_principal_id (pulumi.Input[str]) - Member user principal id (string)

The template_revisions object supports the following:

  • annotations (pulumi.Input[dict]) - Annotations for the cluster template revision (map)

  • clusterConfig (pulumi.Input[dict]) - Cluster configuration (list maxitem: 1)

    • cluster_auth_endpoint (pulumi.Input[dict]) - Local cluster auth endpoint (list maxitems: 1)

      • ca_certs (pulumi.Input[str])

      • enabled (pulumi.Input[bool]) - Enable cluster template revision. Default true (bool)

      • fqdn (pulumi.Input[str])

    • defaultClusterRoleForProjectMembers (pulumi.Input[str]) - Default cluster role for project members (string)

    • default_pod_security_policy_template_id (pulumi.Input[str]) - Default pod security policy template ID (string)

    • desired_agent_image (pulumi.Input[str]) - Desired agent image (string)

    • desired_auth_image (pulumi.Input[str]) - Desired auth image (string)

    • docker_root_dir (pulumi.Input[str]) - Desired auth image (string)

    • enable_cluster_alerting (pulumi.Input[bool]) - Enable built-in cluster alerting. Default: false (bool)

    • enable_cluster_monitoring (pulumi.Input[bool]) - Enable built-in cluster monitoring. Default: false (bool)

    • enable_network_policy (pulumi.Input[bool]) - Enable project network isolation. Default: false (bool)

    • rke_config (pulumi.Input[dict]) - Rancher Kubernetes Engine Config (list maxitems: 1)

      • addonJobTimeout (pulumi.Input[float])

      • addons (pulumi.Input[str])

      • addonsIncludes (pulumi.Input[list])

      • authentication (pulumi.Input[dict])

        • sans (pulumi.Input[list])

        • strategy (pulumi.Input[str])

      • authorization (pulumi.Input[dict])

        • mode (pulumi.Input[str])

        • options (pulumi.Input[dict])

      • bastionHost (pulumi.Input[dict])

        • address (pulumi.Input[str])

        • port (pulumi.Input[str])

        • sshAgentAuth (pulumi.Input[bool])

        • sshKey (pulumi.Input[str])

        • sshKeyPath (pulumi.Input[str])

        • user (pulumi.Input[str])

      • cloudProvider (pulumi.Input[dict])

        • awsCloudProvider (pulumi.Input[dict])

          • global (pulumi.Input[dict])

            • disableSecurityGroupIngress (pulumi.Input[bool])

            • disableStrictZoneCheck (pulumi.Input[bool])

            • elbSecurityGroup (pulumi.Input[str])

            • kubernetesClusterId (pulumi.Input[str])

            • kubernetesClusterTag (pulumi.Input[str])

            • roleArn (pulumi.Input[str])

            • routeTableId (pulumi.Input[str])

            • subnetId (pulumi.Input[str])

            • vpc (pulumi.Input[str])

            • zone (pulumi.Input[str])

          • serviceOverrides (pulumi.Input[list])

            • region (pulumi.Input[str])

            • service (pulumi.Input[str])

            • signingMethod (pulumi.Input[str])

            • signingName (pulumi.Input[str])

            • signingRegion (pulumi.Input[str])

            • url (pulumi.Input[str])

        • azureCloudProvider (pulumi.Input[dict])

          • aadClientCertPassword (pulumi.Input[str])

          • aadClientCertPath (pulumi.Input[str])

          • aadClientId (pulumi.Input[str])

          • aadClientSecret (pulumi.Input[str])

          • cloud (pulumi.Input[str])

          • cloudProviderBackoff (pulumi.Input[bool])

          • cloudProviderBackoffDuration (pulumi.Input[float])

          • cloudProviderBackoffExponent (pulumi.Input[float])

          • cloudProviderBackoffJitter (pulumi.Input[float])

          • cloudProviderBackoffRetries (pulumi.Input[float])

          • cloudProviderRateLimit (pulumi.Input[bool])

          • cloudProviderRateLimitBucket (pulumi.Input[float])

          • cloudProviderRateLimitQps (pulumi.Input[float])

          • location (pulumi.Input[str])

          • maximumLoadBalancerRuleCount (pulumi.Input[float])

          • primaryAvailabilitySetName (pulumi.Input[str])

          • primaryScaleSetName (pulumi.Input[str])

          • resourceGroup (pulumi.Input[str])

          • routeTableName (pulumi.Input[str])

          • securityGroupName (pulumi.Input[str])

          • subnetName (pulumi.Input[str])

          • subscriptionId (pulumi.Input[str])

          • tenant_id (pulumi.Input[str])

          • useInstanceMetadata (pulumi.Input[bool])

          • useManagedIdentityExtension (pulumi.Input[bool])

          • vmType (pulumi.Input[str])

          • vnetName (pulumi.Input[str])

          • vnetResourceGroup (pulumi.Input[str])

        • customCloudProvider (pulumi.Input[str])

        • name (pulumi.Input[str]) - The cluster template revision name (string)

        • openstackCloudProvider (pulumi.Input[dict])

          • blockStorage (pulumi.Input[dict])

            • bsVersion (pulumi.Input[str])

            • ignoreVolumeAz (pulumi.Input[bool])

            • trustDevicePath (pulumi.Input[bool])

          • global (pulumi.Input[dict])

            • authUrl (pulumi.Input[str])

            • caFile (pulumi.Input[str])

            • domainId (pulumi.Input[str])

            • domainName (pulumi.Input[str])

            • password (pulumi.Input[str])

            • region (pulumi.Input[str])

            • tenant_id (pulumi.Input[str])

            • tenantName (pulumi.Input[str])

            • trustId (pulumi.Input[str])

            • username (pulumi.Input[str])

          • loadBalancer (pulumi.Input[dict])

            • createMonitor (pulumi.Input[bool])

            • floatingNetworkId (pulumi.Input[str])

            • lbMethod (pulumi.Input[str])

            • lbProvider (pulumi.Input[str])

            • lbVersion (pulumi.Input[str])

            • manageSecurityGroups (pulumi.Input[bool])

            • monitorDelay (pulumi.Input[str])

            • monitorMaxRetries (pulumi.Input[float])

            • monitorTimeout (pulumi.Input[str])

            • subnetId (pulumi.Input[str])

            • useOctavia (pulumi.Input[bool])

          • metadata (pulumi.Input[dict])

            • requestTimeout (pulumi.Input[float])

            • searchOrder (pulumi.Input[str])

          • route (pulumi.Input[dict])

            • routerId (pulumi.Input[str])

        • vsphereCloudProvider (pulumi.Input[dict])

          • disk (pulumi.Input[dict])

            • scsiControllerType (pulumi.Input[str])

          • global (pulumi.Input[dict])

            • datacenters (pulumi.Input[str])

            • insecureFlag (pulumi.Input[bool])

            • password (pulumi.Input[str])

            • port (pulumi.Input[str])

            • soapRoundtripCount (pulumi.Input[float])

            • user (pulumi.Input[str])

          • network (pulumi.Input[dict])

            • publicNetwork (pulumi.Input[str])

          • virtualCenters (pulumi.Input[list])

            • datacenters (pulumi.Input[str])

            • name (pulumi.Input[str]) - The cluster template revision name (string)

            • password (pulumi.Input[str])

            • port (pulumi.Input[str])

            • soapRoundtripCount (pulumi.Input[float])

            • user (pulumi.Input[str])

          • workspace (pulumi.Input[dict])

            • datacenter (pulumi.Input[str])

            • defaultDatastore (pulumi.Input[str])

            • folder (pulumi.Input[str])

            • resourcepoolPath (pulumi.Input[str])

            • server (pulumi.Input[str])

      • dns (pulumi.Input[dict])

        • nodeSelector (pulumi.Input[dict])

        • provider (pulumi.Input[str])

        • reverseCidrs (pulumi.Input[list])

        • upstreamNameservers (pulumi.Input[list])

      • ignoreDockerVersion (pulumi.Input[bool])

      • ingress (pulumi.Input[dict])

        • extraArgs (pulumi.Input[dict])

        • nodeSelector (pulumi.Input[dict])

        • options (pulumi.Input[dict])

        • provider (pulumi.Input[str])

      • kubernetesVersion (pulumi.Input[str])

      • monitoring (pulumi.Input[dict])

        • options (pulumi.Input[dict])

        • provider (pulumi.Input[str])

      • network (pulumi.Input[dict])

        • calicoNetworkProvider (pulumi.Input[dict])

          • cloudProvider (pulumi.Input[str])

        • canalNetworkProvider (pulumi.Input[dict])

          • iface (pulumi.Input[str])

        • flannelNetworkProvider (pulumi.Input[dict])

          • iface (pulumi.Input[str])

        • options (pulumi.Input[dict])

        • plugin (pulumi.Input[str])

        • weaveNetworkProvider (pulumi.Input[dict])

          • password (pulumi.Input[str])

      • nodes (pulumi.Input[list])

        • address (pulumi.Input[str])

        • dockerSocket (pulumi.Input[str])

        • hostnameOverride (pulumi.Input[str])

        • internalAddress (pulumi.Input[str])

        • labels (pulumi.Input[dict]) - Labels for the cluster template revision (map)

        • nodeId (pulumi.Input[str])

        • port (pulumi.Input[str])

        • roles (pulumi.Input[list])

        • sshAgentAuth (pulumi.Input[bool])

        • sshKey (pulumi.Input[str])

        • sshKeyPath (pulumi.Input[str])

        • user (pulumi.Input[str])

      • prefixPath (pulumi.Input[str])

      • privateRegistries (pulumi.Input[list])

        • isDefault (pulumi.Input[bool])

        • password (pulumi.Input[str])

        • url (pulumi.Input[str])

        • user (pulumi.Input[str])

      • services (pulumi.Input[dict])

        • etcd (pulumi.Input[dict])

          • backup_config (pulumi.Input[dict])

            • enabled (pulumi.Input[bool]) - Enable cluster template revision. Default true (bool)

            • intervalHours (pulumi.Input[float])

            • retention (pulumi.Input[float])

            • s3BackupConfig (pulumi.Input[dict])

                • access_key (pulumi.Input[str])* bucketName (pulumi.Input[str])

                • customCa (pulumi.Input[str])* endpoint (pulumi.Input[str])

                • folder (pulumi.Input[str])* region (pulumi.Input[str])

                • secret_key (pulumi.Input[str])

          • caCert (pulumi.Input[str])

          • cert (pulumi.Input[str])

          • creation (pulumi.Input[str])

          • externalUrls (pulumi.Input[list])

          • extraArgs (pulumi.Input[dict])

          • extraBinds (pulumi.Input[list])

          • extraEnvs (pulumi.Input[list])

          • gid (pulumi.Input[float])

          • image (pulumi.Input[str])

          • key (pulumi.Input[str])

          • path (pulumi.Input[str])

          • retention (pulumi.Input[str])

          • snapshot (pulumi.Input[bool])

          • uid (pulumi.Input[float])

        • kubeApi (pulumi.Input[dict])

          • alwaysPullImages (pulumi.Input[bool])

          • extraArgs (pulumi.Input[dict])

          • extraBinds (pulumi.Input[list])

          • extraEnvs (pulumi.Input[list])

          • image (pulumi.Input[str])

          • podSecurityPolicy (pulumi.Input[bool])

          • serviceClusterIpRange (pulumi.Input[str])

          • serviceNodePortRange (pulumi.Input[str])

        • kubeController (pulumi.Input[dict])

          • clusterCidr (pulumi.Input[str])

          • extraArgs (pulumi.Input[dict])

          • extraBinds (pulumi.Input[list])

          • extraEnvs (pulumi.Input[list])

          • image (pulumi.Input[str])

          • serviceClusterIpRange (pulumi.Input[str])

        • kubelet (pulumi.Input[dict])

          • clusterDnsServer (pulumi.Input[str])

          • clusterDomain (pulumi.Input[str])

          • extraArgs (pulumi.Input[dict])

          • extraBinds (pulumi.Input[list])

          • extraEnvs (pulumi.Input[list])

          • failSwapOn (pulumi.Input[bool])

          • image (pulumi.Input[str])

          • infraContainerImage (pulumi.Input[str])

        • kubeproxy (pulumi.Input[dict])

          • extraArgs (pulumi.Input[dict])

          • extraBinds (pulumi.Input[list])

          • extraEnvs (pulumi.Input[list])

          • image (pulumi.Input[str])

        • scheduler (pulumi.Input[dict])

          • extraArgs (pulumi.Input[dict])

          • extraBinds (pulumi.Input[list])

          • extraEnvs (pulumi.Input[list])

          • image (pulumi.Input[str])

      • sshAgentAuth (pulumi.Input[bool])

      • sshKeyPath (pulumi.Input[str])

    • windowsPreferedCluster (pulumi.Input[bool]) - Windows prefered cluster. Default: false (bool)

  • cluster_template_id (pulumi.Input[str]) - Cluster template ID (string)

  • default (pulumi.Input[bool]) - Default variable value (string)

  • enabled (pulumi.Input[bool]) - Enable cluster template revision. Default true (bool)

  • id (pulumi.Input[str]) - The cluster template revision ID (string)

  • labels (pulumi.Input[dict]) - Labels for the cluster template revision (map)

  • name (pulumi.Input[str]) - The cluster template revision name (string)

  • questions (pulumi.Input[list]) - Cluster template questions (list)

    • default (pulumi.Input[str]) - Default variable value (string)

    • required (pulumi.Input[bool]) - Required variable. Default false (bool)

    • type (pulumi.Input[str]) - Variable type. boolean, int and string are allowed. Default string (string)

    • variable (pulumi.Input[str]) - Variable name (string)

annotations = None

Annotations for the cluster template revision (map)

default_revision_id = None

(Computed) Default cluster template revision ID (string)

labels = None

Labels for the cluster template revision (map)

members = None

Cluster template members (list)

  • accessType (str) - Member access type. Valid values: ["read-only" | "owner"] (string)

  • group_principal_id (str) - Member group principal id (string)

  • user_principal_id (str) - Member user principal id (string)

name = None

The cluster template revision name (string)

template_revisions = None

Cluster template revisions (list)

  • annotations (dict) - Annotations for the cluster template revision (map)

  • clusterConfig (dict) - Cluster configuration (list maxitem: 1)

    • cluster_auth_endpoint (dict) - Local cluster auth endpoint (list maxitems: 1)

      • ca_certs (str)

      • enabled (bool) - Enable cluster template revision. Default true (bool)

      • fqdn (str)

    • defaultClusterRoleForProjectMembers (str) - Default cluster role for project members (string)

    • default_pod_security_policy_template_id (str) - Default pod security policy template ID (string)

    • desired_agent_image (str) - Desired agent image (string)

    • desired_auth_image (str) - Desired auth image (string)

    • docker_root_dir (str) - Desired auth image (string)

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

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

    • enable_network_policy (bool) - Enable project network isolation. Default: false (bool)

    • rke_config (dict) - Rancher Kubernetes Engine Config (list maxitems: 1)

      • addonJobTimeout (float)

      • addons (str)

      • addonsIncludes (list)

      • authentication (dict)

        • sans (list)

        • strategy (str)

      • authorization (dict)

        • mode (str)

        • options (dict)

      • bastionHost (dict)

        • address (str)

        • port (str)

        • sshAgentAuth (bool)

        • sshKey (str)

        • sshKeyPath (str)

        • user (str)

      • cloudProvider (dict)

        • awsCloudProvider (dict)

          • global (dict)

            • disableSecurityGroupIngress (bool)

            • disableStrictZoneCheck (bool)

            • elbSecurityGroup (str)

            • kubernetesClusterId (str)

            • kubernetesClusterTag (str)

            • roleArn (str)

            • routeTableId (str)

            • subnetId (str)

            • vpc (str)

            • zone (str)

          • serviceOverrides (list)

            • region (str)

            • service (str)

            • signingMethod (str)

            • signingName (str)

            • signingRegion (str)

            • url (str)

        • azureCloudProvider (dict)

          • aadClientCertPassword (str)

          • aadClientCertPath (str)

          • aadClientId (str)

          • aadClientSecret (str)

          • cloud (str)

          • cloudProviderBackoff (bool)

          • cloudProviderBackoffDuration (float)

          • cloudProviderBackoffExponent (float)

          • cloudProviderBackoffJitter (float)

          • cloudProviderBackoffRetries (float)

          • cloudProviderRateLimit (bool)

          • cloudProviderRateLimitBucket (float)

          • cloudProviderRateLimitQps (float)

          • location (str)

          • maximumLoadBalancerRuleCount (float)

          • primaryAvailabilitySetName (str)

          • primaryScaleSetName (str)

          • resourceGroup (str)

          • routeTableName (str)

          • securityGroupName (str)

          • subnetName (str)

          • subscriptionId (str)

          • tenant_id (str)

          • useInstanceMetadata (bool)

          • useManagedIdentityExtension (bool)

          • vmType (str)

          • vnetName (str)

          • vnetResourceGroup (str)

        • customCloudProvider (str)

        • name (str) - The cluster template revision name (string)

        • openstackCloudProvider (dict)

          • blockStorage (dict)

            • bsVersion (str)

            • ignoreVolumeAz (bool)

            • trustDevicePath (bool)

          • global (dict)

            • authUrl (str)

            • caFile (str)

            • domainId (str)

            • domainName (str)

            • password (str)

            • region (str)

            • tenant_id (str)

            • tenantName (str)

            • trustId (str)

            • username (str)

          • loadBalancer (dict)

            • createMonitor (bool)

            • floatingNetworkId (str)

            • lbMethod (str)

            • lbProvider (str)

            • lbVersion (str)

            • manageSecurityGroups (bool)

            • monitorDelay (str)

            • monitorMaxRetries (float)

            • monitorTimeout (str)

            • subnetId (str)

            • useOctavia (bool)

          • metadata (dict)

            • requestTimeout (float)

            • searchOrder (str)

          • route (dict)

            • routerId (str)

        • vsphereCloudProvider (dict)

          • disk (dict)

            • scsiControllerType (str)

          • global (dict)

            • datacenters (str)

            • insecureFlag (bool)

            • password (str)

            • port (str)

            • soapRoundtripCount (float)

            • user (str)

          • network (dict)

            • publicNetwork (str)

          • virtualCenters (list)

            • datacenters (str)

            • name (str) - The cluster template revision name (string)

            • password (str)

            • port (str)

            • soapRoundtripCount (float)

            • user (str)

          • workspace (dict)

            • datacenter (str)

            • defaultDatastore (str)

            • folder (str)

            • resourcepoolPath (str)

            • server (str)

      • dns (dict)

        • nodeSelector (dict)

        • provider (str)

        • reverseCidrs (list)

        • upstreamNameservers (list)

      • ignoreDockerVersion (bool)

      • ingress (dict)

        • extraArgs (dict)

        • nodeSelector (dict)

        • options (dict)

        • provider (str)

      • kubernetesVersion (str)

      • monitoring (dict)

        • options (dict)

        • provider (str)

      • network (dict)

        • calicoNetworkProvider (dict)

          • cloudProvider (str)

        • canalNetworkProvider (dict)

          • iface (str)

        • flannelNetworkProvider (dict)

          • iface (str)

        • options (dict)

        • plugin (str)

        • weaveNetworkProvider (dict)

          • password (str)

      • nodes (list)

        • address (str)

        • dockerSocket (str)

        • hostnameOverride (str)

        • internalAddress (str)

        • labels (dict) - Labels for the cluster template revision (map)

        • nodeId (str)

        • port (str)

        • roles (list)

        • sshAgentAuth (bool)

        • sshKey (str)

        • sshKeyPath (str)

        • user (str)

      • prefixPath (str)

      • privateRegistries (list)

        • isDefault (bool)

        • password (str)

        • url (str)

        • user (str)

      • services (dict)

        • etcd (dict)

          • backup_config (dict)

            • enabled (bool) - Enable cluster template revision. Default true (bool)

            • intervalHours (float)

            • retention (float)

            • s3BackupConfig (dict)

                • access_key (str)* bucketName (str)

                • customCa (str)* endpoint (str)

                • folder (str)* region (str)

                • secret_key (str)

          • caCert (str)

          • cert (str)

          • creation (str)

          • externalUrls (list)

          • extraArgs (dict)

          • extraBinds (list)

          • extraEnvs (list)

          • gid (float)

          • image (str)

          • key (str)

          • path (str)

          • retention (str)

          • snapshot (bool)

          • uid (float)

        • kubeApi (dict)

          • alwaysPullImages (bool)

          • extraArgs (dict)

          • extraBinds (list)

          • extraEnvs (list)

          • image (str)

          • podSecurityPolicy (bool)

          • serviceClusterIpRange (str)

          • serviceNodePortRange (str)

        • kubeController (dict)

          • clusterCidr (str)

          • extraArgs (dict)

          • extraBinds (list)

          • extraEnvs (list)

          • image (str)

          • serviceClusterIpRange (str)

        • kubelet (dict)

          • clusterDnsServer (str)

          • clusterDomain (str)

          • extraArgs (dict)

          • extraBinds (list)

          • extraEnvs (list)

          • failSwapOn (bool)

          • image (str)

          • infraContainerImage (str)

        • kubeproxy (dict)

          • extraArgs (dict)

          • extraBinds (list)

          • extraEnvs (list)

          • image (str)

        • scheduler (dict)

          • extraArgs (dict)

          • extraBinds (list)

          • extraEnvs (list)

          • image (str)

      • sshAgentAuth (bool)

      • sshKeyPath (str)

    • windowsPreferedCluster (bool) - Windows prefered cluster. Default: false (bool)

  • cluster_template_id (str) - Cluster template ID (string)

  • default (bool) - Default variable value (string)

  • enabled (bool) - Enable cluster template revision. Default true (bool)

  • id (str) - The cluster template revision ID (string)

  • labels (dict) - Labels for the cluster template revision (map)

  • name (str) - The cluster template revision name (string)

  • questions (list) - Cluster template questions (list)

    • default (str) - Default variable value (string)

    • required (bool) - Required variable. Default false (bool)

    • type (str) - Variable type. boolean, int and string are allowed. Default string (string)

    • variable (str) - Variable name (string)

static get(resource_name, id, opts=None, annotations=None, default_revision_id=None, description=None, labels=None, members=None, name=None, template_revisions=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for the cluster template revision (map)

  • default_revision_id (pulumi.Input[str]) – (Computed) Default cluster template revision ID (string)

  • labels (pulumi.Input[dict]) – Labels for the cluster template revision (map)

  • members (pulumi.Input[list]) – Cluster template members (list)

  • name (pulumi.Input[str]) – The cluster template revision name (string)

  • template_revisions (pulumi.Input[list]) – Cluster template revisions (list)

The members object supports the following:

  • accessType (pulumi.Input[str]) - Member access type. Valid values: ["read-only" | "owner"] (string)

  • group_principal_id (pulumi.Input[str]) - Member group principal id (string)

  • user_principal_id (pulumi.Input[str]) - Member user principal id (string)

The template_revisions object supports the following:

  • annotations (pulumi.Input[dict]) - Annotations for the cluster template revision (map)

  • clusterConfig (pulumi.Input[dict]) - Cluster configuration (list maxitem: 1)

    • cluster_auth_endpoint (pulumi.Input[dict]) - Local cluster auth endpoint (list maxitems: 1)

      • ca_certs (pulumi.Input[str])

      • enabled (pulumi.Input[bool]) - Enable cluster template revision. Default true (bool)

      • fqdn (pulumi.Input[str])

    • defaultClusterRoleForProjectMembers (pulumi.Input[str]) - Default cluster role for project members (string)

    • default_pod_security_policy_template_id (pulumi.Input[str]) - Default pod security policy template ID (string)

    • desired_agent_image (pulumi.Input[str]) - Desired agent image (string)

    • desired_auth_image (pulumi.Input[str]) - Desired auth image (string)

    • docker_root_dir (pulumi.Input[str]) - Desired auth image (string)

    • enable_cluster_alerting (pulumi.Input[bool]) - Enable built-in cluster alerting. Default: false (bool)

    • enable_cluster_monitoring (pulumi.Input[bool]) - Enable built-in cluster monitoring. Default: false (bool)

    • enable_network_policy (pulumi.Input[bool]) - Enable project network isolation. Default: false (bool)

    • rke_config (pulumi.Input[dict]) - Rancher Kubernetes Engine Config (list maxitems: 1)

      • addonJobTimeout (pulumi.Input[float])

      • addons (pulumi.Input[str])

      • addonsIncludes (pulumi.Input[list])

      • authentication (pulumi.Input[dict])

        • sans (pulumi.Input[list])

        • strategy (pulumi.Input[str])

      • authorization (pulumi.Input[dict])

        • mode (pulumi.Input[str])

        • options (pulumi.Input[dict])

      • bastionHost (pulumi.Input[dict])

        • address (pulumi.Input[str])

        • port (pulumi.Input[str])

        • sshAgentAuth (pulumi.Input[bool])

        • sshKey (pulumi.Input[str])

        • sshKeyPath (pulumi.Input[str])

        • user (pulumi.Input[str])

      • cloudProvider (pulumi.Input[dict])

        • awsCloudProvider (pulumi.Input[dict])

          • global (pulumi.Input[dict])

            • disableSecurityGroupIngress (pulumi.Input[bool])

            • disableStrictZoneCheck (pulumi.Input[bool])

            • elbSecurityGroup (pulumi.Input[str])

            • kubernetesClusterId (pulumi.Input[str])

            • kubernetesClusterTag (pulumi.Input[str])

            • roleArn (pulumi.Input[str])

            • routeTableId (pulumi.Input[str])

            • subnetId (pulumi.Input[str])

            • vpc (pulumi.Input[str])

            • zone (pulumi.Input[str])

          • serviceOverrides (pulumi.Input[list])

            • region (pulumi.Input[str])

            • service (pulumi.Input[str])

            • signingMethod (pulumi.Input[str])

            • signingName (pulumi.Input[str])

            • signingRegion (pulumi.Input[str])

            • url (pulumi.Input[str])

        • azureCloudProvider (pulumi.Input[dict])

          • aadClientCertPassword (pulumi.Input[str])

          • aadClientCertPath (pulumi.Input[str])

          • aadClientId (pulumi.Input[str])

          • aadClientSecret (pulumi.Input[str])

          • cloud (pulumi.Input[str])

          • cloudProviderBackoff (pulumi.Input[bool])

          • cloudProviderBackoffDuration (pulumi.Input[float])

          • cloudProviderBackoffExponent (pulumi.Input[float])

          • cloudProviderBackoffJitter (pulumi.Input[float])

          • cloudProviderBackoffRetries (pulumi.Input[float])

          • cloudProviderRateLimit (pulumi.Input[bool])

          • cloudProviderRateLimitBucket (pulumi.Input[float])

          • cloudProviderRateLimitQps (pulumi.Input[float])

          • location (pulumi.Input[str])

          • maximumLoadBalancerRuleCount (pulumi.Input[float])

          • primaryAvailabilitySetName (pulumi.Input[str])

          • primaryScaleSetName (pulumi.Input[str])

          • resourceGroup (pulumi.Input[str])

          • routeTableName (pulumi.Input[str])

          • securityGroupName (pulumi.Input[str])

          • subnetName (pulumi.Input[str])

          • subscriptionId (pulumi.Input[str])

          • tenant_id (pulumi.Input[str])

          • useInstanceMetadata (pulumi.Input[bool])

          • useManagedIdentityExtension (pulumi.Input[bool])

          • vmType (pulumi.Input[str])

          • vnetName (pulumi.Input[str])

          • vnetResourceGroup (pulumi.Input[str])

        • customCloudProvider (pulumi.Input[str])

        • name (pulumi.Input[str]) - The cluster template revision name (string)

        • openstackCloudProvider (pulumi.Input[dict])

          • blockStorage (pulumi.Input[dict])

            • bsVersion (pulumi.Input[str])

            • ignoreVolumeAz (pulumi.Input[bool])

            • trustDevicePath (pulumi.Input[bool])

          • global (pulumi.Input[dict])

            • authUrl (pulumi.Input[str])

            • caFile (pulumi.Input[str])

            • domainId (pulumi.Input[str])

            • domainName (pulumi.Input[str])

            • password (pulumi.Input[str])

            • region (pulumi.Input[str])

            • tenant_id (pulumi.Input[str])

            • tenantName (pulumi.Input[str])

            • trustId (pulumi.Input[str])

            • username (pulumi.Input[str])

          • loadBalancer (pulumi.Input[dict])

            • createMonitor (pulumi.Input[bool])

            • floatingNetworkId (pulumi.Input[str])

            • lbMethod (pulumi.Input[str])

            • lbProvider (pulumi.Input[str])

            • lbVersion (pulumi.Input[str])

            • manageSecurityGroups (pulumi.Input[bool])

            • monitorDelay (pulumi.Input[str])

            • monitorMaxRetries (pulumi.Input[float])

            • monitorTimeout (pulumi.Input[str])

            • subnetId (pulumi.Input[str])

            • useOctavia (pulumi.Input[bool])

          • metadata (pulumi.Input[dict])

            • requestTimeout (pulumi.Input[float])

            • searchOrder (pulumi.Input[str])

          • route (pulumi.Input[dict])

            • routerId (pulumi.Input[str])

        • vsphereCloudProvider (pulumi.Input[dict])

          • disk (pulumi.Input[dict])

            • scsiControllerType (pulumi.Input[str])

          • global (pulumi.Input[dict])

            • datacenters (pulumi.Input[str])

            • insecureFlag (pulumi.Input[bool])

            • password (pulumi.Input[str])

            • port (pulumi.Input[str])

            • soapRoundtripCount (pulumi.Input[float])

            • user (pulumi.Input[str])

          • network (pulumi.Input[dict])

            • publicNetwork (pulumi.Input[str])

          • virtualCenters (pulumi.Input[list])

            • datacenters (pulumi.Input[str])

            • name (pulumi.Input[str]) - The cluster template revision name (string)

            • password (pulumi.Input[str])

            • port (pulumi.Input[str])

            • soapRoundtripCount (pulumi.Input[float])

            • user (pulumi.Input[str])

          • workspace (pulumi.Input[dict])

            • datacenter (pulumi.Input[str])

            • defaultDatastore (pulumi.Input[str])

            • folder (pulumi.Input[str])

            • resourcepoolPath (pulumi.Input[str])

            • server (pulumi.Input[str])

      • dns (pulumi.Input[dict])

        • nodeSelector (pulumi.Input[dict])

        • provider (pulumi.Input[str])

        • reverseCidrs (pulumi.Input[list])

        • upstreamNameservers (pulumi.Input[list])

      • ignoreDockerVersion (pulumi.Input[bool])

      • ingress (pulumi.Input[dict])

        • extraArgs (pulumi.Input[dict])

        • nodeSelector (pulumi.Input[dict])

        • options (pulumi.Input[dict])

        • provider (pulumi.Input[str])

      • kubernetesVersion (pulumi.Input[str])

      • monitoring (pulumi.Input[dict])

        • options (pulumi.Input[dict])

        • provider (pulumi.Input[str])

      • network (pulumi.Input[dict])

        • calicoNetworkProvider (pulumi.Input[dict])

          • cloudProvider (pulumi.Input[str])

        • canalNetworkProvider (pulumi.Input[dict])

          • iface (pulumi.Input[str])

        • flannelNetworkProvider (pulumi.Input[dict])

          • iface (pulumi.Input[str])

        • options (pulumi.Input[dict])

        • plugin (pulumi.Input[str])

        • weaveNetworkProvider (pulumi.Input[dict])

          • password (pulumi.Input[str])

      • nodes (pulumi.Input[list])

        • address (pulumi.Input[str])

        • dockerSocket (pulumi.Input[str])

        • hostnameOverride (pulumi.Input[str])

        • internalAddress (pulumi.Input[str])

        • labels (pulumi.Input[dict]) - Labels for the cluster template revision (map)

        • nodeId (pulumi.Input[str])

        • port (pulumi.Input[str])

        • roles (pulumi.Input[list])

        • sshAgentAuth (pulumi.Input[bool])

        • sshKey (pulumi.Input[str])

        • sshKeyPath (pulumi.Input[str])

        • user (pulumi.Input[str])

      • prefixPath (pulumi.Input[str])

      • privateRegistries (pulumi.Input[list])

        • isDefault (pulumi.Input[bool])

        • password (pulumi.Input[str])

        • url (pulumi.Input[str])

        • user (pulumi.Input[str])

      • services (pulumi.Input[dict])

        • etcd (pulumi.Input[dict])

          • backup_config (pulumi.Input[dict])

            • enabled (pulumi.Input[bool]) - Enable cluster template revision. Default true (bool)

            • intervalHours (pulumi.Input[float])

            • retention (pulumi.Input[float])

            • s3BackupConfig (pulumi.Input[dict])

                • access_key (pulumi.Input[str])* bucketName (pulumi.Input[str])

                • customCa (pulumi.Input[str])* endpoint (pulumi.Input[str])

                • folder (pulumi.Input[str])* region (pulumi.Input[str])

                • secret_key (pulumi.Input[str])

          • caCert (pulumi.Input[str])

          • cert (pulumi.Input[str])

          • creation (pulumi.Input[str])

          • externalUrls (pulumi.Input[list])

          • extraArgs (pulumi.Input[dict])

          • extraBinds (pulumi.Input[list])

          • extraEnvs (pulumi.Input[list])

          • gid (pulumi.Input[float])

          • image (pulumi.Input[str])

          • key (pulumi.Input[str])

          • path (pulumi.Input[str])

          • retention (pulumi.Input[str])

          • snapshot (pulumi.Input[bool])

          • uid (pulumi.Input[float])

        • kubeApi (pulumi.Input[dict])

          • alwaysPullImages (pulumi.Input[bool])

          • extraArgs (pulumi.Input[dict])

          • extraBinds (pulumi.Input[list])

          • extraEnvs (pulumi.Input[list])

          • image (pulumi.Input[str])

          • podSecurityPolicy (pulumi.Input[bool])

          • serviceClusterIpRange (pulumi.Input[str])

          • serviceNodePortRange (pulumi.Input[str])

        • kubeController (pulumi.Input[dict])

          • clusterCidr (pulumi.Input[str])

          • extraArgs (pulumi.Input[dict])

          • extraBinds (pulumi.Input[list])

          • extraEnvs (pulumi.Input[list])

          • image (pulumi.Input[str])

          • serviceClusterIpRange (pulumi.Input[str])

        • kubelet (pulumi.Input[dict])

          • clusterDnsServer (pulumi.Input[str])

          • clusterDomain (pulumi.Input[str])

          • extraArgs (pulumi.Input[dict])

          • extraBinds (pulumi.Input[list])

          • extraEnvs (pulumi.Input[list])

          • failSwapOn (pulumi.Input[bool])

          • image (pulumi.Input[str])

          • infraContainerImage (pulumi.Input[str])

        • kubeproxy (pulumi.Input[dict])

          • extraArgs (pulumi.Input[dict])

          • extraBinds (pulumi.Input[list])

          • extraEnvs (pulumi.Input[list])

          • image (pulumi.Input[str])

        • scheduler (pulumi.Input[dict])

          • extraArgs (pulumi.Input[dict])

          • extraBinds (pulumi.Input[list])

          • extraEnvs (pulumi.Input[list])

          • image (pulumi.Input[str])

      • sshAgentAuth (pulumi.Input[bool])

      • sshKeyPath (pulumi.Input[str])

    • windowsPreferedCluster (pulumi.Input[bool]) - Windows prefered cluster. Default: false (bool)

  • cluster_template_id (pulumi.Input[str]) - Cluster template ID (string)

  • default (pulumi.Input[bool]) - Default variable value (string)

  • enabled (pulumi.Input[bool]) - Enable cluster template revision. Default true (bool)

  • id (pulumi.Input[str]) - The cluster template revision ID (string)

  • labels (pulumi.Input[dict]) - Labels for the cluster template revision (map)

  • name (pulumi.Input[str]) - The cluster template revision name (string)

  • questions (pulumi.Input[list]) - Cluster template questions (list)

    • default (pulumi.Input[str]) - Default variable value (string)

    • required (pulumi.Input[bool]) - Required variable. Default false (bool)

    • type (pulumi.Input[str]) - Variable type. boolean, int and string are allowed. Default string (string)

    • variable (pulumi.Input[str]) - Variable name (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.EtcdBackup(resource_name, opts=None, annotations=None, backup_config=None, cluster_id=None, filename=None, labels=None, manual=None, name=None, namespace_id=None, __props__=None, __name__=None, __opts__=None)

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

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for Etcd Backup object (map)

  • backup_config (pulumi.Input[dict]) – Backup config for etcd backup (list maxitems:1)

  • cluster_id (pulumi.Input[str]) – Cluster ID to config Etcd Backup (string)

  • filename (pulumi.Input[str]) – Filename of the Etcd Backup (string)

  • labels (pulumi.Input[dict]) – Labels for Etcd Backup object (map)

  • manual (pulumi.Input[bool]) – Manual execution of the Etcd Backup. Default false (bool)

  • name (pulumi.Input[str]) – The name of the Etcd Backup (string)

  • namespace_id (pulumi.Input[str]) – Description for the Etcd Backup (string)

The backup_config object supports the following:

  • enabled (pulumi.Input[bool]) - Enable etcd backup (bool)

  • intervalHours (pulumi.Input[float]) - Interval hours for etcd backup. Default 12 (int)

  • retention (pulumi.Input[float]) - Retention for etcd backup. Default 6 (int)

  • s3BackupConfig (pulumi.Input[dict]) - S3 config options for etcd backup. Valid for imported and rke clusters. (list maxitems:1)

    • access_key (pulumi.Input[str]) - Access key for S3 service (string)

    • bucketName (pulumi.Input[str]) - Bucket name for S3 service (string)

    • customCa (pulumi.Input[str]) - Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)

    • endpoint (pulumi.Input[str]) - Endpoint for S3 service (string)

    • folder (pulumi.Input[str]) - Folder for S3 service. Available from Rancher v2.2.7 (string)

    • region (pulumi.Input[str]) - Region for S3 service (string)

    • secret_key (pulumi.Input[str]) - Secret key for S3 service (string)

annotations = None

Annotations for Etcd Backup object (map)

backup_config = None

Backup config for etcd backup (list maxitems:1)

  • enabled (bool) - Enable etcd backup (bool)

  • intervalHours (float) - Interval hours for etcd backup. Default 12 (int)

  • retention (float) - Retention for etcd backup. Default 6 (int)

  • s3BackupConfig (dict) - S3 config options for etcd backup. Valid for imported and rke clusters. (list maxitems:1)

    • access_key (str) - Access key for S3 service (string)

    • bucketName (str) - Bucket name for S3 service (string)

    • customCa (str) - Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)

    • endpoint (str) - Endpoint for S3 service (string)

    • folder (str) - Folder for S3 service. Available from Rancher v2.2.7 (string)

    • region (str) - Region for S3 service (string)

    • secret_key (str) - Secret key for S3 service (string)

cluster_id = None

Cluster ID to config Etcd Backup (string)

filename = None

Filename of the Etcd Backup (string)

labels = None

Labels for Etcd Backup object (map)

manual = None

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

name = None

The name of the Etcd Backup (string)

namespace_id = None

Description for the Etcd Backup (string)

static get(resource_name, id, opts=None, annotations=None, backup_config=None, cluster_id=None, filename=None, labels=None, manual=None, name=None, namespace_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • annotations (pulumi.Input[dict]) – Annotations for Etcd Backup object (map)

  • backup_config (pulumi.Input[dict]) – Backup config for etcd backup (list maxitems:1)

  • cluster_id (pulumi.Input[str]) – Cluster ID to config Etcd Backup (string)

  • filename (pulumi.Input[str]) – Filename of the Etcd Backup (string)

  • labels (pulumi.Input[dict]) – Labels for Etcd Backup object (map)

  • manual (pulumi.Input[bool]) – Manual execution of the Etcd Backup. Default false (bool)

  • name (pulumi.Input[str]) – The name of the Etcd Backup (string)

  • namespace_id (pulumi.Input[str]) – Description for the Etcd Backup (string)

The backup_config object supports the following:

  • enabled (pulumi.Input[bool]) - Enable etcd backup (bool)

  • intervalHours (pulumi.Input[float]) - Interval hours for etcd backup. Default 12 (int)

  • retention (pulumi.Input[float]) - Retention for etcd backup. Default 6 (int)

  • s3BackupConfig (pulumi.Input[dict]) - S3 config options for etcd backup. Valid for imported and rke clusters. (list maxitems:1)

    • access_key (pulumi.Input[str]) - Access key for S3 service (string)

    • bucketName (pulumi.Input[str]) - Bucket name for S3 service (string)

    • customCa (pulumi.Input[str]) - Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)

    • endpoint (pulumi.Input[str]) - Endpoint for S3 service (string)

    • folder (pulumi.Input[str]) - Folder for S3 service. Available from Rancher v2.2.7 (string)

    • region (pulumi.Input[str]) - Region for S3 service (string)

    • secret_key (pulumi.Input[str]) - Secret key for S3 service (string)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rancher2.GetAppResult(annotations=None, answers=None, catalog_name=None, description=None, external_id=None, labels=None, name=None, project_id=None, revision_id=None, target_namespace=None, template_name=None, template_version=None, values_yaml=None, id=None)

A collection of values returned by getApp.

annotations = None

(Computed) Annotations for the catalog (map)

answers = None

(Computed) Answers for the app (map)

catalog_name = None

(Computed) Catalog name of the app (string)

description = None

(Computed) Description for the app (string)

external_id = None

(Computed) The URL of the helm catalog app (string)

labels = None

(Computed) Labels for the catalog (map)

revision_id = None

(Computed) Current revision id for the app (string)

template_name = None

(Computed) Template name of the app (string)

template_version = None

(Computed) Template version of the app (string)

values_yaml = None

(Computed) values.yaml base64 encoded file content for the app (string)

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_rancher2.GetCatalogResult(annotations=None, branch=None, cluster_id=None, description=None, kind=None, labels=None, name=None, password=None, project_id=None, scope=None, url=None, username=None, id=None)

A collection of values returned by getCatalog.

annotations = None

(Computed) Annotations for the catalog (map)

branch = None

(Computed) The branch of the catalog repo to use (string)

cluster_id = None

(Computed) The cluster id of the catalog (string)

description = None

(Computed) A catalog description (string)

kind = None

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

labels = None

(Computed) Labels for the catalog (map)

password = None

(Computed/Sensitive) The password to access the catalog if needed (string)

project_id = None

(Computed) The project id of the catalog (string)

url = None

(Computed) The url of the catalog repo (string)

username = None

(Computed/Sensitive) The username to access the catalog if needed (string)

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_rancher2.GetCertificateResult(annotations=None, certs=None, description=None, labels=None, name=None, namespace_id=None, project_id=None, id=None)

A collection of values returned by getCertificate.

annotations = None

(Computed) Annotations for certificate object (map)

certs = None

(Computed) Base64 encoded certs (string)

description = None

(Computed) A certificate description (string)

labels = None

(Computed) Labels for certificate object (map)

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_rancher2.GetCloudCredentialResult(annotations=None, labels=None, name=None, id=None)

A collection of values returned by getCloudCredential.

annotations = None

(Computed) Annotations for the Cloud Credential (map)

labels = None

(Computed) Labels for the Cloud Credential (map)

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_rancher2.GetClusterAlertGroupResult(annotations=None, cluster_id=None, description=None, group_interval_seconds=None, group_wait_seconds=None, labels=None, name=None, recipients=None, repeat_interval_seconds=None, id=None)

A collection of values returned by getClusterAlertGroup.

annotations = None

(Computed) The cluster alert group annotations (map)

description = None

(Computed) The cluster alert group description (string)

group_interval_seconds = None

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

group_wait_seconds = None

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

labels = None

(Computed) The cluster alert group labels (map)

recipients = None

(Computed) The cluster alert group recipients (list)

repeat_interval_seconds = None

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

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_rancher2.GetClusterAlterRuleResult(annotations=None, cluster_id=None, event_rule=None, group_id=None, group_interval_seconds=None, group_wait_seconds=None, inherited=None, labels=None, metric_rule=None, name=None, node_rule=None, repeat_interval_seconds=None, severity=None, system_service_rule=None, id=None)

A collection of values returned by getClusterAlterRule.

annotations = None

(Computed) The cluster alert rule annotations (map)

event_rule = None

(Computed) The cluster alert rule event rule. ConflictsWith: “metric_rule”, “node_rule”, “system_service_rule”` (list Maxitems:1)

group_id = None

(Computed) The cluster alert rule alert group ID (string)

group_interval_seconds = None

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

group_wait_seconds = None

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

inherited = None

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

labels = None

(Computed) The cluster alert rule labels (map)

metric_rule = None

(Computed) The cluster alert rule metric rule. ConflictsWith: “event_rule”, “node_rule”, “system_service_rule”` (list Maxitems:1)

node_rule = None

(Computed) The cluster alert rule node rule. ConflictsWith: “event_rule”, “metric_rule”, “system_service_rule”` (list Maxitems:1)

repeat_interval_seconds = None

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

severity = None

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

system_service_rule = None

(Computed) The cluster alert rule system service rule. ConflictsWith: “event_rule”, “metric_rule”, “node_rule”` (list Maxitems:1)

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_rancher2.GetClusterDriverResult(active=None, actual_url=None, annotations=None, builtin=None, checksum=None, labels=None, name=None, ui_url=None, url=None, whitelist_domains=None, id=None)

A collection of values returned by getClusterDriver.

active = None

(Computed) Specify if the cluster driver state (bool)

actual_url = None

(Computed) Actual url of the cluster driver (string)

annotations = None

(Computed) Annotations of the resource (map)

builtin = None

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

checksum = None

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

labels = None

(Computed) Labels of the resource (map)

ui_url = None

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

whitelist_domains = None

(Computed) Domains to whitelist for the ui (list)

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_rancher2.GetClusterLoggingResult(annotations=None, cluster_id=None, elasticsearch_config=None, fluentd_config=None, kafka_config=None, kind=None, labels=None, name=None, namespace_id=None, output_flush_interval=None, output_tags=None, splunk_config=None, syslog_config=None, id=None)

A collection of values returned by getClusterLogging.

annotations = None

(Computed) Annotations for Cluster Logging object (map)

elasticsearch_config = None

(Computed) The elasticsearch config for Cluster Logging. For kind = elasticsearch (list maxitems:1)

fluentd_config = None

(Computed) The fluentd config for Cluster Logging. For kind = fluentd (list maxitems:1)

kafka_config = None

(Computed) The kafka config for Cluster Logging. For kind = kafka (list maxitems:1)

kind = None

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

labels = None

(Computed) Labels for Cluster Logging object (map)

name = None

(Computed) The name of the cluster logging config (string)

namespace_id = None

(Computed) The namespace id from cluster logging (string)

output_flush_interval = None

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

output_tags = None

(computed) The output tags for Cluster Logging (map)

splunk_config = None

(Computed) The splunk config for Cluster Logging. For kind = splunk (list maxitems:1)

syslog_config = None

(Computed) The syslog config for Cluster Logging. For kind = syslog (list maxitems:1)

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_rancher2.GetClusterResult(aks_config=None, annotations=None, cluster_auth_endpoint=None, cluster_monitoring_input=None, cluster_registration_token=None, cluster_template_answers=None, cluster_template_id=None, cluster_template_questions=None, cluster_template_revision_id=None, default_pod_security_policy_template_id=None, default_project_id=None, description=None, driver=None, eks_config=None, enable_cluster_alerting=None, enable_cluster_monitoring=None, enable_network_policy=None, gke_config=None, kube_config=None, labels=None, name=None, rke_config=None, system_project_id=None, id=None)

A collection of values returned by getCluster.

aks_config = None

(Computed) The Azure aks configuration for aks Clusters. Conflicts with eks_config, gke_config and rke_config (list maxitems:1)

annotations = None

(Computed) Annotations for Node Pool object (map)

cluster_auth_endpoint = None

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