Namespace Pulumi.Rancher2

Classes

ActiveDirectory

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.

AuthConfigAdfs

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

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Auth Config ADFS
    var adfs = new Rancher2.AuthConfigAdfs(&quot;adfs&quot;, new Rancher2.AuthConfigAdfsArgs
    {
        DisplayNameField = &quot;&lt;DISPLAY_NAME_FIELD>&quot;,
        GroupsField = &quot;&lt;GROUPS_FIELD>&quot;,
        IdpMetadataContent = &quot;&lt;IDP_METADATA_CONTENT>&quot;,
        RancherApiHost = &quot;https://&lt;RANCHER_API_HOST>&quot;,
        SpCert = &quot;&lt;SP_CERT>&quot;,
        SpKey = &quot;&lt;SP_KEY>&quot;,
        UidField = &quot;&lt;UID_FIELD>&quot;,
        UserNameField = &quot;&lt;USER_NAME_FIELD>&quot;,
    });
}

}

AuthConfigAzureAd

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

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Auth Config AzureAD
    var azuread = new Rancher2.AuthConfigAzureAd(&quot;azuread&quot;, new Rancher2.AuthConfigAzureAdArgs
    {
        ApplicationId = &quot;&lt;AZUREAD_APP_ID>&quot;,
        ApplicationSecret = &quot;&lt;AZUREAD_APP_SECRET>&quot;,
        AuthEndpoint = &quot;&lt;AZUREAD_AUTH_ENDPOINT>&quot;,
        GraphEndpoint = &quot;&lt;AZUREAD_GRAPH_ENDPOINT>&quot;,
        RancherUrl = &quot;&lt;RANCHER_URL>&quot;,
        TenantId = &quot;&lt;AZUREAD_TENANT_ID>&quot;,
        TokenEndpoint = &quot;&lt;AZUREAD_TOKEN_ENDPOINT>&quot;,
    });
}

}

AuthConfigFreeIpa

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.

AuthConfigGithub

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

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Auth Config Github
    var github = new Rancher2.AuthConfigGithub(&quot;github&quot;, new Rancher2.AuthConfigGithubArgs
    {
        ClientId = &quot;&lt;GITHUB_CLIENT_ID>&quot;,
        ClientSecret = &quot;&lt;GITHUB_CLIENT_SECRET>&quot;,
    });
}

}

AuthConfigKeycloak

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

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Auth Config KeyCloak
    var keycloak = new Rancher2.AuthConfigKeycloak(&quot;keycloak&quot;, new Rancher2.AuthConfigKeycloakArgs
    {
        DisplayNameField = &quot;&lt;DISPLAY_NAME_FIELD>&quot;,
        GroupsField = &quot;&lt;GROUPS_FIELD>&quot;,
        IdpMetadataContent = &quot;&lt;IDP_METADATA_CONTENT>&quot;,
        RancherApiHost = &quot;https://&lt;RANCHER_API_HOST>&quot;,
        SpCert = &quot;&lt;SP_CERT>&quot;,
        SpKey = &quot;&lt;SP_KEY>&quot;,
        UidField = &quot;&lt;UID_FIELD>&quot;,
        UserNameField = &quot;&lt;USER_NAME_FIELD>&quot;,
    });
}

}

AuthConfigOkta

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

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Auth Config OKTA
    var okta = new Rancher2.AuthConfigOkta(&quot;okta&quot;, new Rancher2.AuthConfigOktaArgs
    {
        DisplayNameField = &quot;&lt;DISPLAY_NAME_FIELD>&quot;,
        GroupsField = &quot;&lt;GROUPS_FIELD>&quot;,
        IdpMetadataContent = &quot;&lt;IDP_METADATA_CONTENT>&quot;,
        RancherApiHost = &quot;https://&lt;RANCHER_API_HOST>&quot;,
        SpCert = &quot;&lt;SP_CERT>&quot;,
        SpKey = &quot;&lt;SP_KEY>&quot;,
        UidField = &quot;&lt;UID_FIELD>&quot;,
        UserNameField = &quot;&lt;USER_NAME_FIELD>&quot;,
    });
}

}

AuthConfigOpenLdap

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.

AuthConfigPing

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

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Auth Config Ping
    var ping = new Rancher2.AuthConfigPing(&quot;ping&quot;, new Rancher2.AuthConfigPingArgs
    {
        DisplayNameField = &quot;&lt;DISPLAY_NAME_FIELD>&quot;,
        GroupsField = &quot;&lt;GROUPS_FIELD>&quot;,
        IdpMetadataContent = &quot;&lt;IDP_METADATA_CONTENT>&quot;,
        RancherApiHost = &quot;https://&lt;RANCHER_API_HOST>&quot;,
        SpCert = &quot;&lt;SP_CERT>&quot;,
        SpKey = &quot;&lt;SP_KEY>&quot;,
        UidField = &quot;&lt;UID_FIELD>&quot;,
        UserNameField = &quot;&lt;USER_NAME_FIELD>&quot;,
    });
}

}

Catalog

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new Rancher2 Global Catalog
    var foo_global = new Rancher2.Catalog(&quot;foo-global&quot;, new Rancher2.CatalogArgs
    {
        Url = &quot;https://&lt;CATALOG_URL>&quot;,
    });
    // Create a new Rancher2 Cluster Catalog
    var foo_cluster = new Rancher2.Catalog(&quot;foo-cluster&quot;, new Rancher2.CatalogArgs
    {
        Scope = &quot;cluster&quot;,
        Url = &quot;https://&lt;CATALOG_URL>&quot;,
    });
    // Create a new Rancher2 Project Catalog
    var foo_project = new Rancher2.Catalog(&quot;foo-project&quot;, new Rancher2.CatalogArgs
    {
        Scope = &quot;project&quot;,
        Url = &quot;https://&lt;CATALOG_URL>&quot;,
    });
}

}

Certificate

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

CloudCredential

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, linode, openstack and vsphere credentials config are supported for Cloud Credential.

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Cloud Credential
    var foo = new Rancher2.CloudCredential(&quot;foo&quot;, new Rancher2.CloudCredentialArgs
    {
        Amazonec2CredentialConfig = new Rancher2.Inputs.CloudCredentialAmazonec2CredentialConfigArgs
        {
            AccessKey = &quot;&lt;AWS_ACCESS_KEY>&quot;,
            SecretKey = &quot;&lt;AWS_SECRET_KEY>&quot;,
        },
        Description = &quot;foo test&quot;,
    });
}

}

Cluster

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

ClusterDriver

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.

ClusterLogging

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new Rancher2 Cluster Logging
    var foo = new Rancher2.ClusterLogging(&quot;foo&quot;, new Rancher2.ClusterLoggingArgs
    {
        ClusterId = &quot;&lt;cluster_id>&quot;,
        Kind = &quot;syslog&quot;,
        SyslogConfig = new Rancher2.Inputs.ClusterLoggingSyslogConfigArgs
        {
            Endpoint = &quot;&lt;syslog_endpoint>&quot;,
            Protocol = &quot;udp&quot;,
            Severity = &quot;notice&quot;,
            SslVerify = false,
        },
    });
}

}

ClusterRoleTemplateBinding

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new Rancher2 Cluster Role Template Binding
    var foo = new Rancher2.ClusterRoleTemplateBinding(&quot;foo&quot;, new Rancher2.ClusterRoleTemplateBindingArgs
    {
        ClusterId = &quot;&lt;cluster_id>&quot;,
        RoleTemplateId = &quot;&lt;role_template_id>&quot;,
        UserId = &quot;&lt;user_id>&quot;,
    });
}

}

ClusterRoleTemplateBindingArgs

ClusterRoleTemplateBindingState

GetClusterRoleTemplateBindingArgs

GetClusterRoleTemplateBindingResult

GetPodSecurityPolicyTemplateArgs

GetPodSecurityPolicyTemplateResult

GetProjectRoleTemplateBindingArgs

GetProjectRoleTemplateBindingResult

GlobalRoleBinding

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Global Role Binding using user_id
    var foo = new Rancher2.GlobalRoleBinding(&quot;foo&quot;, new Rancher2.GlobalRoleBindingArgs
    {
        GlobalRoleId = &quot;admin&quot;,
        UserId = &quot;user-XXXXX&quot;,
    });
    // Create a new rancher2 Global Role Binding using group_principal_id
    var foo2 = new Rancher2.GlobalRoleBinding(&quot;foo2&quot;, new Rancher2.GlobalRoleBindingArgs
    {
        GlobalRoleId = &quot;admin&quot;,
        GroupPrincipalId = &quot;local://g-XXXXX&quot;,
    });
}

}

Namespace

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Namespace
    var foo = new Rancher2.Namespace(&quot;foo&quot;, new Rancher2.NamespaceArgs
    {
        ContainerResourceLimit = new Rancher2.Inputs.NamespaceContainerResourceLimitArgs
        {
            LimitsCpu = &quot;20m&quot;,
            LimitsMemory = &quot;20Mi&quot;,
            RequestsCpu = &quot;1m&quot;,
            RequestsMemory = &quot;1Mi&quot;,
        },
        Description = &quot;foo namespace&quot;,
        ProjectId = &quot;&lt;PROJECT_ID>&quot;,
        ResourceQuota = new Rancher2.Inputs.NamespaceResourceQuotaArgs
        {
            Limit = new Rancher2.Inputs.NamespaceResourceQuotaLimitArgs
            {
                LimitsCpu = &quot;100m&quot;,
                LimitsMemory = &quot;100Mi&quot;,
                RequestsStorage = &quot;1Gi&quot;,
            },
        },
    });
}

}

NodeDriver

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Node Driver
    var foo = new Rancher2.NodeDriver(&quot;foo&quot;, new Rancher2.NodeDriverArgs
    {
        Active = true,
        Builtin = false,
        Checksum = &quot;0x0&quot;,
        Description = &quot;Foo description&quot;,
        ExternalId = &quot;foo_external&quot;,
        UiUrl = &quot;local://ui&quot;,
        Url = &quot;local://&quot;,
        WhitelistDomains = 
        {
            &quot;*.foo.com&quot;,
        },
    });
}

}

NodePool

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

NodeTemplate

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

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

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Node Template up to Rancher 2.1.x
    var foo = new Rancher2.NodeTemplate(&quot;foo&quot;, new Rancher2.NodeTemplateArgs
    {
        Amazonec2Config = new Rancher2.Inputs.NodeTemplateAmazonec2ConfigArgs
        {
            AccessKey = &quot;AWS_ACCESS_KEY&quot;,
            Ami = &quot;&lt;AMI_ID>&quot;,
            Region = &quot;&lt;REGION>&quot;,
            SecretKey = &quot;&lt;AWS_SECRET_KEY>&quot;,
            SecurityGroup = 
            {
                &quot;&lt;AWS_SECURITY_GROUP>&quot;,
            },
            SubnetId = &quot;&lt;SUBNET_ID>&quot;,
            VpcId = &quot;&lt;VPC_ID>&quot;,
            Zone = &quot;&lt;ZONE>&quot;,
        },
        Description = &quot;foo test&quot;,
    });
}

}

PodSecurityPolicyTemplateState

Project

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Project
    var foo = new Rancher2.Project(&quot;foo&quot;, new Rancher2.ProjectArgs
    {
        ClusterId = &quot;&lt;CLUSTER_ID>&quot;,
        ContainerResourceLimit = new Rancher2.Inputs.ProjectContainerResourceLimitArgs
        {
            LimitsCpu = &quot;20m&quot;,
            LimitsMemory = &quot;20Mi&quot;,
            RequestsCpu = &quot;1m&quot;,
            RequestsMemory = &quot;1Mi&quot;,
        },
        ResourceQuota = new Rancher2.Inputs.ProjectResourceQuotaArgs
        {
            NamespaceDefaultLimit = new Rancher2.Inputs.ProjectResourceQuotaNamespaceDefaultLimitArgs
            {
                LimitsCpu = &quot;2000m&quot;,
                LimitsMemory = &quot;500Mi&quot;,
                RequestsStorage = &quot;1Gi&quot;,
            },
            ProjectLimit = new Rancher2.Inputs.ProjectResourceQuotaProjectLimitArgs
            {
                LimitsCpu = &quot;2000m&quot;,
                LimitsMemory = &quot;2000Mi&quot;,
                RequestsStorage = &quot;2Gi&quot;,
            },
        },
    });
}

}

ProjectLogging

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Project Logging
    var foo = new Rancher2.ProjectLogging(&quot;foo&quot;, new Rancher2.ProjectLoggingArgs
    {
        Kind = &quot;syslog&quot;,
        ProjectId = &quot;&lt;project_id>&quot;,
        SyslogConfig = new Rancher2.Inputs.ProjectLoggingSyslogConfigArgs
        {
            Endpoint = &quot;&lt;syslog_endpoint>&quot;,
            Protocol = &quot;udp&quot;,
            Severity = &quot;notice&quot;,
            SslVerify = false,
        },
    });
}

}

ProjectRoleTemplateBinding

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Project Role Template Binding
    var foo = new Rancher2.ProjectRoleTemplateBinding(&quot;foo&quot;, new Rancher2.ProjectRoleTemplateBindingArgs
    {
        ProjectId = &quot;&lt;project_id>&quot;,
        RoleTemplateId = &quot;&lt;role_template_id>&quot;,
        UserId = &quot;&lt;user_id>&quot;,
    });
}

}

ProjectRoleTemplateBindingArgs

ProjectRoleTemplateBindingState

The provider type for the rancher2 package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

ProviderArgs

Registry

RegistryArgs

RegistryState

RoleTempalte

RoleTempalteArgs

RoleTempalteState

Secret

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

Depending of the availability, there are 2 types of Rancher v2 secrets:

Project secret: Available to all namespaces in the project_id
Namespaced secret: Available to just namespace_id in the project_id

SecretArgs

SecretState

Setting

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

On create, if setting already exists, provider will import it and update its value.

On destroy, if setting is a system setting like server-url, provider'll not delete it from Rancher, it'll just update setting value to default and remove it from tfstate.

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Setting
    var foo = new Rancher2.Setting(&quot;foo&quot;, new Rancher2.SettingArgs
    {
        Value = &quot;&lt;VALUE>&quot;,
    });
}

}

SettingArgs

SettingState

Token

Provides a Rancher v2 Token resource. This can be used to create Tokens for Rancher v2 provider user and retrieve their information.

There are 2 kind of tokens:

no scoped: valid for global system.
scoped: valid for just a specific cluster (cluster_id should be provided).

Tokens can't be updated once created. Any diff in token data will recreate the token. If any token expire, Rancher2 provider will generate a diff to regenerate it.

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Token scoped
    var foo = new Rancher2.Token(&quot;foo&quot;, new Rancher2.TokenArgs
    {
        ClusterId = &quot;&lt;cluster-id>&quot;,
        Description = &quot;foo token&quot;,
        Ttl = 1200,
    });
}

}

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 User
    var fooUser = new Rancher2.User(&quot;fooUser&quot;, new Rancher2.UserArgs
    {
        Enabled = true,
        Password = &quot;changeme&quot;,
        Username = &quot;foo&quot;,
    });
    // Create a new rancher2 global_role_binding for User
    var fooGlobalRoleBinding = new Rancher2.GlobalRoleBinding(&quot;fooGlobalRoleBinding&quot;, new Rancher2.GlobalRoleBindingArgs
    {
        GlobalRoleId = &quot;user-base&quot;,
        UserId = fooUser.Id,
    });
}

}