Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 2.32 KB

configuration.md

File metadata and controls

84 lines (57 loc) · 2.32 KB
Raw

Configuration Guide

Summary

This SDK uses a structure called "Config" to store and manage configuration, read "config/config.go" file's comments of public functions for more information.

Except for AccessKeyID and SecretAccessKey, you can also configure the API servers for private cloud usage scenario. All available configurable items are list in default configuration file.

Default Configuration File:

# QingCloud services configuration

qy_access_key_id: 'ACCESS_KEY_ID'
qy_secret_access_key: 'SECRET_ACCESS_KEY'

host: 'api.qingcloud.com'
port: 443
protocol: 'https'
uri: '/iaas'
connection_retries: 3

# Valid log levels are "debug", "info", "warn", "error", and "fatal".
log_level: 'warn'

Usage

  1. Just create a config structure instance with your API AccessKey, and initialize services that you need using Init() function of target service.

  2. Or if you do not want to expose your AccessKeyID and SecretAccessKey, you can also call our API without them in the following way:

  • Go to our IAM service, create an instance role and attach it to your instance.
  • Create the config structure instance without AccessKeyID and SecretAccessKey.

Note that you can also configure your own credential proxy server (where you retrieve tokens) in configuration file like this:

credential_proxy_protocol: 'http'
credential_proxy_host: '169.254.169.254'
credential_proxy_port: 80
credential_proxy_uri: '/latest/meta-data/security-credentials'

Code Snippet

Create default configuration

defaultConfig, _ := config.NewDefault()

Create configuration from AccessKey

configuration, _ := config.New("ACCESS_KEY_ID", "SECRET_ACCESS_KEY")

anotherConfiguration := config.NewDefault()
anotherConfiguration.AccessKeyID = "ACCESS_KEY_ID"
anotherConfiguration.SecretAccessKey = "SECRET_ACCESS_KEY"

Load user configuration

userConfig, _ := config.NewDefault().LoadUserConfig()

Load configuration from config file

configFromFile, _ := config.NewDefault().LoadConfigFromFilepath("PATH/TO/FILE")

Change API server

moreConfiguration, _ := config.NewDefault()

moreConfiguration.Protocol = "https",
moreConfiguration.Host = "api.private.com",
moreConfiguration.Port = 4433,
moreConfiguration.URI = "/iaas",