Rancher 2 v4.0.0, Apr 20 23

rancher2.AuthConfigGithub

Explore with Pulumi AI

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 System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    // Create a new rancher2 Auth Config Github
    var github = new Rancher2.AuthConfigGithub("github", new()
    {
        ClientId = "<GITHUB_CLIENT_ID>",
        ClientSecret = "<GITHUB_CLIENT_SECRET>",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rancher2.NewAuthConfigGithub(ctx, "github", &rancher2.AuthConfigGithubArgs{
			ClientId:     pulumi.String("<GITHUB_CLIENT_ID>"),
			ClientSecret: pulumi.String("<GITHUB_CLIENT_SECRET>"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.AuthConfigGithub;
import com.pulumi.rancher2.AuthConfigGithubArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var github = new AuthConfigGithub("github", AuthConfigGithubArgs.builder()        
            .clientId("<GITHUB_CLIENT_ID>")
            .clientSecret("<GITHUB_CLIENT_SECRET>")
            .build());

    }
}

import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 Auth Config Github
github = rancher2.AuthConfigGithub("github",
    client_id="<GITHUB_CLIENT_ID>",
    client_secret="<GITHUB_CLIENT_SECRET>")

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

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

resources:
  # Create a new rancher2 Auth Config Github
  github:
    type: rancher2:AuthConfigGithub
    properties:
      clientId: <GITHUB_CLIENT_ID>
      clientSecret: <GITHUB_CLIENT_SECRET>

Create AuthConfigGithub Resource

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

@overload
def AuthConfigGithub(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     access_mode: Optional[str] = None,
                     allowed_principal_ids: Optional[Sequence[str]] = None,
                     annotations: Optional[Mapping[str, Any]] = None,
                     client_id: Optional[str] = None,
                     client_secret: Optional[str] = None,
                     enabled: Optional[bool] = None,
                     hostname: Optional[str] = None,
                     labels: Optional[Mapping[str, Any]] = None,
                     tls: Optional[bool] = None)
@overload
def AuthConfigGithub(resource_name: str,
                     args: AuthConfigGithubArgs,
                     opts: Optional[ResourceOptions] = None)

func NewAuthConfigGithub(ctx *Context, name string, args AuthConfigGithubArgs, opts ...ResourceOption) (*AuthConfigGithub, error)

public AuthConfigGithub(string name, AuthConfigGithubArgs args, CustomResourceOptions? opts = null)

public AuthConfigGithub(String name, AuthConfigGithubArgs args)
public AuthConfigGithub(String name, AuthConfigGithubArgs args, CustomResourceOptions options)

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

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

resource_name str: The unique name of the resource.
args AuthConfigGithubArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AuthConfigGithubArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

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

AuthConfigGithub Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AuthConfigGithub resource accepts the following input properties:

ClientId string: Github auth Client ID (string)
ClientSecret string: Github auth Client secret (string)
AccessMode string: Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
AllowedPrincipalIds List<string>: 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 Dictionary<string, object>: Annotations of the resource (map)
Enabled bool: Enable auth config provider. Default true (bool)
Hostname string: Github hostname to connect. Default github.com (string)
Labels Dictionary<string, object>: Labels of the resource (map)
Tls bool: Enable TLS connection. Default true (bool)

ClientId string: Github auth Client ID (string)
ClientSecret string: Github auth Client secret (string)
AccessMode string: Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
AllowedPrincipalIds []string: 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 map[string]interface{}: Annotations of the resource (map)
Enabled bool: Enable auth config provider. Default true (bool)
Hostname string: Github hostname to connect. Default github.com (string)
Labels map[string]interface{}: Labels of the resource (map)
Tls bool: Enable TLS connection. Default true (bool)

clientId String: Github auth Client ID (string)
clientSecret String: Github auth Client secret (string)
accessMode String: Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
allowedPrincipalIds List<String>: 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 Map<String,Object>: Annotations of the resource (map)
enabled Boolean: Enable auth config provider. Default true (bool)
hostname String: Github hostname to connect. Default github.com (string)
labels Map<String,Object>: Labels of the resource (map)
tls Boolean: Enable TLS connection. Default true (bool)

clientId string: Github auth Client ID (string)
clientSecret string: Github auth Client secret (string)
accessMode string: Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
allowedPrincipalIds string[]: 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 {[key: string]: any}: Annotations of the resource (map)
enabled boolean: Enable auth config provider. Default true (bool)
hostname string: Github hostname to connect. Default github.com (string)
labels {[key: string]: any}: Labels of the resource (map)
tls boolean: Enable TLS connection. Default true (bool)

client_id str: Github auth Client ID (string)
client_secret str: Github auth Client secret (string)
access_mode str: Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
allowed_principal_ids Sequence[str]: 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 Mapping[str, Any]: Annotations of the resource (map)
enabled bool: Enable auth config provider. Default true (bool)
hostname str: Github hostname to connect. Default github.com (string)
labels Mapping[str, Any]: Labels of the resource (map)
tls bool: Enable TLS connection. Default true (bool)

clientId String: Github auth Client ID (string)
clientSecret String: Github auth Client secret (string)
accessMode String: Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
allowedPrincipalIds List<String>: 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 Map<Any>: Annotations of the resource (map)
enabled Boolean: Enable auth config provider. Default true (bool)
hostname String: Github hostname to connect. Default github.com (string)
labels Map<Any>: Labels of the resource (map)
tls Boolean: Enable TLS connection. Default true (bool)

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Name string: (Computed) The name of the resource (string)
Type string: (Computed) The type of the resource (string)

Id string: The provider-assigned unique ID for this managed resource.
Name string: (Computed) The name of the resource (string)
Type string: (Computed) The type of the resource (string)

id String: The provider-assigned unique ID for this managed resource.
name String: (Computed) The name of the resource (string)
type String: (Computed) The type of the resource (string)

id string: The provider-assigned unique ID for this managed resource.
name string: (Computed) The name of the resource (string)
type string: (Computed) The type of the resource (string)

id str: The provider-assigned unique ID for this managed resource.
name str: (Computed) The name of the resource (string)
type str: (Computed) The type of the resource (string)

id String: The provider-assigned unique ID for this managed resource.
name String: (Computed) The name of the resource (string)
type String: (Computed) The type of the resource (string)

Look up Existing AuthConfigGithub Resource

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_mode: Optional[str] = None,
        allowed_principal_ids: Optional[Sequence[str]] = None,
        annotations: Optional[Mapping[str, Any]] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        enabled: Optional[bool] = None,
        hostname: Optional[str] = None,
        labels: Optional[Mapping[str, Any]] = None,
        name: Optional[str] = None,
        tls: Optional[bool] = None,
        type: Optional[str] = None) -> AuthConfigGithub

func GetAuthConfigGithub(ctx *Context, name string, id IDInput, state *AuthConfigGithubState, opts ...ResourceOption) (*AuthConfigGithub, error)

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

public static AuthConfigGithub get(String name, Output<String> id, AuthConfigGithubState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccessMode string: Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
AllowedPrincipalIds List<string>: 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 Dictionary<string, object>: Annotations of the resource (map)
ClientId string: Github auth Client ID (string)
ClientSecret string: Github auth Client secret (string)
Enabled bool: Enable auth config provider. Default true (bool)
Hostname string: Github hostname to connect. Default github.com (string)
Labels Dictionary<string, object>: Labels of the resource (map)
Name string: (Computed) The name of the resource (string)
Tls bool: Enable TLS connection. Default true (bool)
Type string: (Computed) The type of the resource (string)

AccessMode string: Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
AllowedPrincipalIds []string: 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 map[string]interface{}: Annotations of the resource (map)
ClientId string: Github auth Client ID (string)
ClientSecret string: Github auth Client secret (string)
Enabled bool: Enable auth config provider. Default true (bool)
Hostname string: Github hostname to connect. Default github.com (string)
Labels map[string]interface{}: Labels of the resource (map)
Name string: (Computed) The name of the resource (string)
Tls bool: Enable TLS connection. Default true (bool)
Type string: (Computed) The type of the resource (string)

accessMode String: Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
allowedPrincipalIds List<String>: 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 Map<String,Object>: Annotations of the resource (map)
clientId String: Github auth Client ID (string)
clientSecret String: Github auth Client secret (string)
enabled Boolean: Enable auth config provider. Default true (bool)
hostname String: Github hostname to connect. Default github.com (string)
labels Map<String,Object>: Labels of the resource (map)
name String: (Computed) The name of the resource (string)
tls Boolean: Enable TLS connection. Default true (bool)
type String: (Computed) The type of the resource (string)

accessMode string: Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
allowedPrincipalIds string[]: 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 {[key: string]: any}: Annotations of the resource (map)
clientId string: Github auth Client ID (string)
clientSecret string: Github auth Client secret (string)
enabled boolean: Enable auth config provider. Default true (bool)
hostname string: Github hostname to connect. Default github.com (string)
labels {[key: string]: any}: Labels of the resource (map)
name string: (Computed) The name of the resource (string)
tls boolean: Enable TLS connection. Default true (bool)
type string: (Computed) The type of the resource (string)

access_mode str: Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
allowed_principal_ids Sequence[str]: 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 Mapping[str, Any]: Annotations of the resource (map)
client_id str: Github auth Client ID (string)
client_secret str: Github auth Client secret (string)
enabled bool: Enable auth config provider. Default true (bool)
hostname str: Github hostname to connect. Default github.com (string)
labels Mapping[str, Any]: Labels of the resource (map)
name str: (Computed) The name of the resource (string)
tls bool: Enable TLS connection. Default true (bool)
type str: (Computed) The type of the resource (string)

accessMode String: Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)
allowedPrincipalIds List<String>: 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 Map<Any>: Annotations of the resource (map)
clientId String: Github auth Client ID (string)
clientSecret String: Github auth Client secret (string)
enabled Boolean: Enable auth config provider. Default true (bool)
hostname String: Github hostname to connect. Default github.com (string)
labels Map<Any>: Labels of the resource (map)
name String: (Computed) The name of the resource (string)
tls Boolean: Enable TLS connection. Default true (bool)
type String: (Computed) The type of the resource (string)

Package Details

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