Skip to content

Latest commit

 

History

History
155 lines (110 loc) · 4.82 KB

index.md

File metadata and controls

155 lines (110 loc) · 4.82 KB
Raw

Huawei Cloud Stack Provider

The Huawei Cloud Stack provider is used to interact with the many resources supported by Huawei Cloud Stack. The provider needs to be configured with the proper credentials before it can be used.

Use the navigation to the left to read about the available resources.

Compatibility with HCS

Provider Version Huawei Cloud Stack Version
v2.3.x v8.3.0
v2.4.x v8.3.1 and v8.5.*

Example Usage

Terraform 0.13 and later:

terraform {
  required_providers {
    hcs = {
      source  = "huaweicloud/hcs"
      version = "~> 2.4.0"
    }
  }
}

# Configure the Huawei Cloud Stack Provider
provider "hcs" {
  region       = "cn-north-4"
  project_name = "my-project-name"
  cloud        = "mycloud.com"
  access_key   = "my-access-key"
  secret_key   = "my-secret-key"
}

# Create a VPC
resource "hcs_vpc" "example" {
  name = "my_vpc"
  cidr = "192.168.0.0/16"
}

Authentication

The Huawei Cloud Stack provider offers a flexible means of providing credentials for authentication. The following methods are supported, in this order, and explained below:

  • Static credentials
  • Environment variables

Static credentials

!> WARNING: Hard-coding credentials into any Terraform configuration is not recommended, and risks secret leakage should this file ever be committed to a public version control system.

Static credentials can be provided by adding an access_key and secret_key in-line in the provider block:

Usage:

provider "hcs" {
  region       = "cn-north-4"
  project_name = "my-project-name"
  cloud        = "mycloud.com"
  access_key   = "my-access-key"
  secret_key   = "my-secret-key"
}

Environment variables

You can provide your credentials via the HCS_ACCESS_KEY and HCS_SECRET_KEY environment variables, representing your Huawei Cloud Stack Access Key and Secret Key, respectively.

provider "hcs" {}

Usage:

$ export HCS_ACCESS_KEY="anaccesskey"
$ export HCS_SECRET_KEY="asecretkey"
$ export HCS_REGION_NAME="cn-north-4"
$ export HCS_PROJECT_NAME="my-project-name"
$ export HCS_CLOUD="mycloud.com"
$ terraform plan

Configuration Reference

The following arguments are supported:

  • region - (Optional) This is the Huawei Cloud Stack region. It must be provided when using static credentials authentication, but it can also be sourced from the HCS_REGION_NAME environment variables.

  • access_key - (Optional) The access key of the Huawei Cloud Stack to use. If omitted, the HCS_ACCESS_KEY environment variable is used.

  • secret_key - (Optional) The secret key of the Huawei Cloud Stack to use. If omitted, the HCS_SECRET_KEY environment variable is used.

  • project_name - (Optional) The Name of the project to login with. If omitted, the HCS_PROJECT_NAME environment

  • cloud - (Optional) The endpoint of the cloud provider. If omitted, the HCS_CLOUD environment variable is used.

  • auth_url - (Optional, Required before 1.14.0) The Identity authentication URL. If omitted, the HCS_AUTH_URL environment variable is used. Defaults to https://iam-apigateway-proxy.{{region}}.{{cloud}}:443.

  • insecure - (Optional) Trust self-signed SSL certificates. If omitted, the HCS_INSECURE environment variable is used.

  • max_retries - (Optional) This is the maximum number of times an API call is retried, in the case where requests are being throttled or experiencing transient failures. The delay between the subsequent API calls increases exponentially. The default value is 5. If omitted, the HCS_MAX_RETRIES environment variable is used.

  • enterprise_project_id - (Optional) Default Enterprise Project ID for supported resources. If omitted, the HCS_ENTERPRISE_PROJECT_ID environment variable is used.

  • endpoints - (Optional) Configuration block in key/value pairs for customizing service endpoints. The following endpoints support to be customized: autoscaling, ecs, ims, vpc, nat, evs, obs, sfs, cce, rds, dds, iam. An example provider configuration:

provider "hcs" {
  ...
  endpoints = {
    ecs = "https://ecs-customizing-endpoint.com"
  }
}
  • domain_name - (Required) The name of the agency domain for assume role. If omitted, the HCS_ASSUME_ROLE_DOMAIN_NAME environment variable is used.

Testing and Development

In order to run the Acceptance Tests for development, the following environment variables must also be set:

  • HCS_CLOUD - The endpoint of the Huawei Cloud Stack to use.

  • HCS_PROJECT_NAME - The project name of the Huawei Cloud Stack to use.

  • HCS_REGION_NAME - The region in which to create the resources.

  • HCS_ACCESS_KEY - The access key of the Huawei Cloud Stack to use.

  • HCS_SECRET_KEY - The secret key of the Huawei Cloud Stack to use.

You should be able to use any Huawei Cloud Stack environment to develop on as long as the above environment variables are set.