Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Rancher2 Provider
  3. API Docs
  4. Feature
Rancher 2 v9.0.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-rancher2

rancher2.Feature

Explore with Pulumi AI

Rancher 2 v9.0.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-rancher2

Provides a Rancher v2 Feature resource. This can be used to enable/disable experimental features for Rancher v2 environments.

Experimental features already exist at Rancher v2.5.x systems, so they can just be updated:

  • On create, provider will read Feature from Rancher and update its value. It will return an error if feature doesn’t exist
  • On destroy, provider will not delete feature from Rancher, just from tfstate

Note: Some Rancher features as fleet, may force a Rancher reboot once updated. The provider will wait until Rancher is rebooted. If you are modifying more than one feature in a row, and any of them requires a Rancher reboot, pulumi up may fail on first run. Run pulumi up again should work fine.

Example Usage

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

// Create a new rancher2 Feature
const fleet = new rancher2.Feature("fleet", {
    name: "fleet",
    value: "<VALUE>",
});
Copy
import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 Feature
fleet = rancher2.Feature("fleet",
    name="fleet",
    value="<VALUE>")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a new rancher2 Feature
		_, err := rancher2.NewFeature(ctx, "fleet", &rancher2.FeatureArgs{
			Name:  pulumi.String("fleet"),
			Value: pulumi.Bool("<VALUE>"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    // Create a new rancher2 Feature
    var fleet = new Rancher2.Feature("fleet", new()
    {
        Name = "fleet",
        Value = "<VALUE>",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.Feature;
import com.pulumi.rancher2.FeatureArgs;
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) {
        // Create a new rancher2 Feature
        var fleet = new Feature("fleet", FeatureArgs.builder()
            .name("fleet")
            .value("<VALUE>")
            .build());

    }
}
Copy
resources:
  # Create a new rancher2 Feature
  fleet:
    type: rancher2:Feature
    properties:
      name: fleet
      value: <VALUE>
Copy

Create Feature Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Feature(name: string, args?: FeatureArgs, opts?: CustomResourceOptions);
@overload
def Feature(resource_name: str,
            args: Optional[FeatureArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Feature(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            annotations: Optional[Mapping[str, str]] = None,
            labels: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            value: Optional[bool] = None)
func NewFeature(ctx *Context, name string, args *FeatureArgs, opts ...ResourceOption) (*Feature, error)
public Feature(string name, FeatureArgs? args = null, CustomResourceOptions? opts = null)
public Feature(String name, FeatureArgs args)
public Feature(String name, FeatureArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args FeatureArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args FeatureArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args FeatureArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args FeatureArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FeatureArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var featureResource = new Rancher2.Feature("featureResource", new()
{
    Annotations = 
    {
        { "string", "string" },
    },
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    Value = false,
});
Copy
example, err := rancher2.NewFeature(ctx, "featureResource", &rancher2.FeatureArgs{
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:  pulumi.String("string"),
	Value: pulumi.Bool(false),
})
Copy
var featureResource = new Feature("featureResource", FeatureArgs.builder()
    .annotations(Map.of("string", "string"))
    .labels(Map.of("string", "string"))
    .name("string")
    .value(false)
    .build());
Copy
feature_resource = rancher2.Feature("featureResource",
    annotations={
        "string": "string",
    },
    labels={
        "string": "string",
    },
    name="string",
    value=False)
Copy
const featureResource = new rancher2.Feature("featureResource", {
    annotations: {
        string: "string",
    },
    labels: {
        string: "string",
    },
    name: "string",
    value: false,
});
Copy
type: rancher2:Feature
properties:
    annotations:
        string: string
    labels:
        string: string
    name: string
    value: false
Copy

Feature Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Feature resource accepts the following input properties:

Annotations Dictionary<string, string>
Annotations for feature object (map)
Labels Dictionary<string, string>
Labels for feature object (map)
Name Changes to this property will trigger replacement. string
The name of the feature (string)
Value bool
The value of the feature. Default: false (bool)
Annotations map[string]string
Annotations for feature object (map)
Labels map[string]string
Labels for feature object (map)
Name Changes to this property will trigger replacement. string
The name of the feature (string)
Value bool
The value of the feature. Default: false (bool)
annotations Map<String,String>
Annotations for feature object (map)
labels Map<String,String>
Labels for feature object (map)
name Changes to this property will trigger replacement. String
The name of the feature (string)
value Boolean
The value of the feature. Default: false (bool)
annotations {[key: string]: string}
Annotations for feature object (map)
labels {[key: string]: string}
Labels for feature object (map)
name Changes to this property will trigger replacement. string
The name of the feature (string)
value boolean
The value of the feature. Default: false (bool)
annotations Mapping[str, str]
Annotations for feature object (map)
labels Mapping[str, str]
Labels for feature object (map)
name Changes to this property will trigger replacement. str
The name of the feature (string)
value bool
The value of the feature. Default: false (bool)
annotations Map<String>
Annotations for feature object (map)
labels Map<String>
Labels for feature object (map)
name Changes to this property will trigger replacement. String
The name of the feature (string)
value Boolean
The value of the feature. Default: false (bool)

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Feature Resource

Get an existing Feature 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?: FeatureState, opts?: CustomResourceOptions): Feature
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        value: Optional[bool] = None) -> Feature
func GetFeature(ctx *Context, name string, id IDInput, state *FeatureState, opts ...ResourceOption) (*Feature, error)
public static Feature Get(string name, Input<string> id, FeatureState? state, CustomResourceOptions? opts = null)
public static Feature get(String name, Output<String> id, FeatureState state, CustomResourceOptions options)
resources:  _:    type: rancher2:Feature    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Annotations Dictionary<string, string>
Annotations for feature object (map)
Labels Dictionary<string, string>
Labels for feature object (map)
Name Changes to this property will trigger replacement. string
The name of the feature (string)
Value bool
The value of the feature. Default: false (bool)
Annotations map[string]string
Annotations for feature object (map)
Labels map[string]string
Labels for feature object (map)
Name Changes to this property will trigger replacement. string
The name of the feature (string)
Value bool
The value of the feature. Default: false (bool)
annotations Map<String,String>
Annotations for feature object (map)
labels Map<String,String>
Labels for feature object (map)
name Changes to this property will trigger replacement. String
The name of the feature (string)
value Boolean
The value of the feature. Default: false (bool)
annotations {[key: string]: string}
Annotations for feature object (map)
labels {[key: string]: string}
Labels for feature object (map)
name Changes to this property will trigger replacement. string
The name of the feature (string)
value boolean
The value of the feature. Default: false (bool)
annotations Mapping[str, str]
Annotations for feature object (map)
labels Mapping[str, str]
Labels for feature object (map)
name Changes to this property will trigger replacement. str
The name of the feature (string)
value bool
The value of the feature. Default: false (bool)
annotations Map<String>
Annotations for feature object (map)
labels Map<String>
Labels for feature object (map)
name Changes to this property will trigger replacement. String
The name of the feature (string)
value Boolean
The value of the feature. Default: false (bool)

Package Details

Repository
Rancher2 pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.
Rancher 2 v9.0.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-rancher2