terraform-provider-stax

command module
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 9, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

README

Stax Terraform Provider (Developer Preview)

This is the official Terraform provider for Stax.

Please Note: The Stax Terraform Provider is currently in Developer Preview and is intended strictly for feedback purposes only. Do not use this provider for production workloads.

Usage

NOTE: This provider is built with the assumption that you are a Stax customer and are familiar with how to create and access API Tokens.

variable "installation" {
  description = "installation region name"
}

variable "api_token_access_key" {
  description = "api token access key"
}

variable "api_token_secret_key" {
  description = "api token secret key"
}

terraform {
  required_providers {
    stax = {
      source = "registry.terraform.io/stax/stax"
    }
  }
}

provider "stax" {
  installation         = var.installation
  api_token_access_key = var.api_token_access_key
  api_token_secret_key = var.api_token_secret_key
}

Supported Resources

Type Resource Data Source
Account
AccountType
Permission Sets
Policies
APIToken
User
Group
NetworkHub
Workload
Workload Manifest

Limitations

  1. The results of data sources is currently currently returning the first page from the Stax API, this is while we gauge impact and performance of the provider.

Development

To provide the required secrets during development and integration testing some environment variables are required to run examples. These can be configured using an .envrc file which is loaded by direnv.

Example .envrc contents.

export STAX_ACCESS_KEY=whatever_access_key
export STAX_SECRET_KEY=whatever_secret_key
export STAX_INSTALLATION=au1
export TF_LOG=INFO

# used to test importing a stax account
export IMPORT_STAX_ACCOUNT_ID=whatever_uuid

# used to test importing a stax account type
export IMPORT_STAX_ACCOUNT_TYPE_ID=whatever_uuid

# used to test creating/updating a stax account
export ACCOUNT_TYPE_ID=whatever_uuid

Contributing

For more information on contributing the to the Stax Go SDK, please see our guide.

Getting Help

  • If you're having trouble using the Stax SDK, please refer to our documentation.
  • If you've encountered an issue or found a bug, please open an issue.
  • For any other requests, please contact Stax support.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
api/apigw
This package signs requests to API Gateway.
This package signs requests to API Gateway.
api/auth/cognito
This package provides a function which authenticates a user against Cognito and returns the AWS config and IDP tokens.
This package provides a function which authenticates a user against Cognito and returns the AWS config and IDP tokens.
api/auth/sts
This package provides a function which gets AWS credentials from Cognito Identity using the provided ID token
This package provides a function which gets AWS credentials from Cognito Identity using the provided ID token
api/helpers
Package helpers contains helper functions.
Package helpers contains helper functions.
api/openapi/client
Package client provides primitives to interact with the openapi HTTP API.
Package client provides primitives to interact with the openapi HTTP API.
api/openapi/models
Package models provides primitives to interact with the openapi HTTP API.
Package models provides primitives to interact with the openapi HTTP API.
api/openapi/server
Package server provides primitives to interact with the openapi HTTP API.
Package server provides primitives to interact with the openapi HTTP API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL