features

Documentation

Index

• Constants
• Variables
• func AddBetaDescription(description string, resourceType core.ResourceType) string
• func AddExperimentDescription(description, experiment string, resourceType core.ResourceType) string
• func BetaResourcesEnabled(ctx context.Context, data *core.ProviderData, diags *diag.Diagnostics) bool
• func CheckBetaResourcesEnabled(ctx context.Context, data *core.ProviderData, diags *diag.Diagnostics, ...)
• func CheckExperimentEnabled(ctx context.Context, data *core.ProviderData, experiment, resourceName string, ...)
• func CheckExperimentEnabledWithoutError(ctx context.Context, data *core.ProviderData, experiment, resourceName string, ...) bool
• func ValidExperiment(experiment string, diags *diag.Diagnostics) bool

Constants

const (
	RoutingTablesExperiment = "routing-tables"
	NetworkExperiment       = "network"
	IamExperiment           = "iam"
)

Variables

var AvailableExperiments = []string{IamExperiment, RoutingTablesExperiment, NetworkExperiment}

Functions

func AddBetaDescription

func AddBetaDescription(description string, resourceType core.ResourceType) string

func AddExperimentDescription

func AddExperimentDescription(description, experiment string, resourceType core.ResourceType) string

func BetaResourcesEnabled

func BetaResourcesEnabled(ctx context.Context, data *core.ProviderData, diags *diag.Diagnostics) bool

BetaResourcesEnabled returns whether this provider has beta functionality enabled.

In order of precedence, beta functionality can be managed by:

• Environment Variable `STACKIT_TF_ENABLE_BETA_RESOURCES` - `true` is enabled, `false` is disabled.
• Provider configuration feature flag `enable_beta` - `true` is enabled, `false` is disabled.

func CheckBetaResourcesEnabled

func CheckBetaResourcesEnabled(ctx context.Context, data *core.ProviderData, diags *diag.Diagnostics, resourceName string, resourceType core.ResourceType)

CheckBetaResourcesEnabled is a helper function to log and add a warning or error if the beta functionality is not enabled.

Should be called in the Configure method of a beta resource. Then, check for Errors in the diags using the diags.HasError() method.

func CheckExperimentEnabled

func CheckExperimentEnabled(ctx context.Context, data *core.ProviderData, experiment, resourceName string, resourceType core.ResourceType, diags *diag.Diagnostics)

Check if an experiment is enabled.

func CheckExperimentEnabledWithoutError

func CheckExperimentEnabledWithoutError(ctx context.Context, data *core.ProviderData, experiment, resourceName string, resourceType core.ResourceType, diags *diag.Diagnostics) bool

func ValidExperiment

func ValidExperiment(experiment string, diags *diag.Diagnostics) bool

Check if an experiment is valid.