mirror of https://github.com/status-im/consul.git
Bump go-discover to support EC2 Metadata Service v2 (#6865)
Refs https://github.com/hashicorp/go-discover/pull/128 * deps: add replace directive for gocheck Transitive dep, source at https://launchpad.net/gocheck indicates project moved. This also avoids a dependency on bzr when fetching modules. Refs https://github.com/hashicorp/consul/pull/6818 * deps: make update-vendor * test: update retry-join expected names from go-discover
This commit is contained in:
Mike Morris
GitHub
parent
7ac6a085c5
commit
66b8c20990
|
|
@ -12,8 +12,9 @@ func TestAgentRetryNewDiscover(t *testing.T) {
|
|||
d, err := newDiscover()
|
||||
require.NoError(t, err)
|
||||
expected := []string{
|
||||
"aliyun", "aws", "azure", "digitalocean", "gce", "k8s", "mdns",
|
||||
"os", "packet", "scaleway", "softlayer", "triton", "vsphere",
|
||||
"aliyun", "aws", "azure", "digitalocean", "gce", "k8s", "linode",
|
||||
"mdns", "os", "packet", "scaleway", "softlayer", "tencentcloud",
|
||||
"triton", "vsphere",
|
||||
}
|
||||
require.Equal(t, expected, d.Names())
|
||||
}
|
||||
|
|
|
|||
6
go.mod
6
go.mod
|
|
@ -6,6 +6,8 @@ replace github.com/hashicorp/consul/api => ./api
|
|||
|
||||
replace github.com/hashicorp/consul/sdk => ./sdk
|
||||
|
||||
replace launchpad.net/gocheck => github.com/go-check/check v0.0.0-20140225173054-eb6ee6f84d0a848c7f11b46cd11f28875ba56b1c
|
||||
|
||||
require (
|
||||
github.com/Azure/go-autorest v10.15.3+incompatible // indirect
|
||||
github.com/Microsoft/go-winio v0.4.3 // indirect
|
||||
|
|
@ -14,7 +16,7 @@ require (
|
|||
github.com/armon/circbuf v0.0.0-20150827004946-bbbad097214e
|
||||
github.com/armon/go-metrics v0.0.0-20190430140413-ec5e00d3c878
|
||||
github.com/armon/go-radix v1.0.0
|
||||
github.com/aws/aws-sdk-go v1.25.32
|
||||
github.com/aws/aws-sdk-go v1.25.41
|
||||
github.com/coredns/coredns v1.1.2
|
||||
github.com/digitalocean/godo v1.10.0 // indirect
|
||||
github.com/docker/go-connections v0.3.0
|
||||
|
|
@ -30,7 +32,7 @@ require (
|
|||
github.com/hashicorp/go-bexpr v0.1.2
|
||||
github.com/hashicorp/go-checkpoint v0.0.0-20171009173528-1545e56e46de
|
||||
github.com/hashicorp/go-cleanhttp v0.5.1
|
||||
github.com/hashicorp/go-discover v0.0.0-20190403160810-22221edb15cd
|
||||
github.com/hashicorp/go-discover v0.0.0-20191202160150-7ec2cfbda7a2
|
||||
github.com/hashicorp/go-hclog v0.9.2
|
||||
github.com/hashicorp/go-memdb v1.0.3
|
||||
github.com/hashicorp/go-msgpack v0.5.5
|
||||
|
|
|
|||
33
go.sum
33
go.sum
|
|
@ -26,10 +26,8 @@ github.com/armon/go-radix v0.0.0-20180808171621-7fddfc383310 h1:BUAU3CGlLvorLI26
|
|||
github.com/armon/go-radix v0.0.0-20180808171621-7fddfc383310/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8=
|
||||
github.com/armon/go-radix v1.0.0 h1:F4z6KzEeeQIMeLFa97iZU6vupzoecKdU5TX24SNppXI=
|
||||
github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8=
|
||||
github.com/aws/aws-sdk-go v1.15.24 h1:xLAdTA/ore6xdPAljzZRed7IGqQgC+nY+ERS5vaj4Ro=
|
||||
github.com/aws/aws-sdk-go v1.15.24/go.mod h1:mFuSZ37Z9YOHbQEwBWztmVzqXrEkub65tZoCYDt7FT0=
|
||||
github.com/aws/aws-sdk-go v1.25.32 h1:GhqlDvuPXnlW46VoKvfLZkJj5IA6jGLO+/TUPCJSYOY=
|
||||
github.com/aws/aws-sdk-go v1.25.32/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo=
|
||||
github.com/aws/aws-sdk-go v1.25.41 h1:/hj7nZ0586wFqpwjNpzWiUTwtaMgxAZNZKHay80MdXw=
|
||||
github.com/aws/aws-sdk-go v1.25.41/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo=
|
||||
github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973 h1:xJ4a3vCFaGF/jqvzLMYoU8P317H5OQ+Via4RmuPwCS0=
|
||||
github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q=
|
||||
github.com/bgentry/speakeasy v0.1.0 h1:ByYyxL9InA1OWqxJqqp2A5pYHUrCiAL6K3J+LKSsQkY=
|
||||
|
|
@ -54,6 +52,10 @@ github.com/digitalocean/godo v1.1.1 h1:v0A7yF3xmKLjjdJGIeBbINfMufcrrRhqZsxuVQMoT
|
|||
github.com/digitalocean/godo v1.1.1/go.mod h1:h6faOIcZ8lWIwNQ+DN7b3CgX4Kwby5T+nbpNqkUIozU=
|
||||
github.com/digitalocean/godo v1.10.0 h1:uW1/FcvZE/hoixnJcnlmIUvTVNdZCLjRLzmDtRi1xXY=
|
||||
github.com/digitalocean/godo v1.10.0/go.mod h1:h6faOIcZ8lWIwNQ+DN7b3CgX4Kwby5T+nbpNqkUIozU=
|
||||
github.com/dimchansky/utfbom v1.1.0 h1:FcM3g+nofKgUteL8dm/UpdRXNC9KmADgTpLKsu0TRo4=
|
||||
github.com/dimchansky/utfbom v1.1.0/go.mod h1:rO41eb7gLfo8SF1jd9F8HplJm1Fewwi4mQvIirEdv+8=
|
||||
github.com/dnaeon/go-vcr v1.0.1 h1:r8L/HqC0Hje5AXMu1ooW8oyQyOFv4GxqpL0nRP7SLLY=
|
||||
github.com/dnaeon/go-vcr v1.0.1/go.mod h1:aBB1+wY4s93YsC3HHjMBMrwTj2R9FHDzUr9KyGc8n1E=
|
||||
github.com/docker/go-connections v0.3.0 h1:3lOnM9cSzgGwx8VfK/NGOW5fLQ0GjIlCkaktF+n1M6o=
|
||||
github.com/docker/go-connections v0.3.0/go.mod h1:Gbd7IOopHjR8Iph03tsViu4nIes5XhDvyHbTtUxmeec=
|
||||
github.com/elazarl/go-bindata-assetfs v0.0.0-20160803192304-e1a2a7ec64b0 h1:ZoRgc53qJCfSLimXqJDrmBhnt5GChDsExMCK7t48o0Y=
|
||||
|
|
@ -69,8 +71,7 @@ github.com/fsnotify/fsnotify v1.4.7 h1:IXs+QLmnXW2CcXuY+8Mzv/fWEsPGWxqefPtCP5CnV
|
|||
github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
|
||||
github.com/ghodss/yaml v1.0.0 h1:wQHKEahhL6wmXdzwWG11gIVCkOv05bNOh+Rxn0yngAk=
|
||||
github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
|
||||
github.com/go-ini/ini v1.25.4 h1:Mujh4R/dH6YL8bxuISne3xX2+qcQ9p0IxKAP6ExWoUo=
|
||||
github.com/go-ini/ini v1.25.4/go.mod h1:ByCAeIL28uOIIG0E3PJtZPDL8WnHpFKFOtgjp+3Ies8=
|
||||
github.com/go-check/check v0.0.0-20140225173054-eb6ee6f84d0a848c7f11b46cd11f28875ba56b1c/go.mod h1:9ES+weclKsC9YodN5RgxqK/VD9HM9JsCSh7rNhMZE98=
|
||||
github.com/go-ldap/ldap v3.0.2+incompatible h1:kD5HQcAzlQ7yrhfn+h+MSABeAy/jAJhvIJ/QDllP44g=
|
||||
github.com/go-ldap/ldap v3.0.2+incompatible/go.mod h1:qfd9rJvER9Q0/D/Sqn1DfHRoBp40uXYvFoEVrNEPqRc=
|
||||
github.com/go-ole/go-ole v1.2.1 h1:2lOsA72HgjxAuMlKpFiCbHTvu44PIVkZ5hqm3RSdI/E=
|
||||
|
|
@ -119,8 +120,8 @@ github.com/hashicorp/go-checkpoint v0.0.0-20171009173528-1545e56e46de/go.mod h1:
|
|||
github.com/hashicorp/go-cleanhttp v0.5.0/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80=
|
||||
github.com/hashicorp/go-cleanhttp v0.5.1 h1:dH3aiDG9Jvb5r5+bYHsikaOUIpcM0xvgMXVoDkXMzJM=
|
||||
github.com/hashicorp/go-cleanhttp v0.5.1/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80=
|
||||
github.com/hashicorp/go-discover v0.0.0-20190403160810-22221edb15cd h1:SynRxs8h2h7lLSA5py5a3WWkYpImhREtju0CuRd97wc=
|
||||
github.com/hashicorp/go-discover v0.0.0-20190403160810-22221edb15cd/go.mod h1:ueUgD9BeIocT7QNuvxSyJyPAM9dfifBcaWmeybb67OY=
|
||||
github.com/hashicorp/go-discover v0.0.0-20191202160150-7ec2cfbda7a2 h1:r7GtRT+VXoM5WqHMxSVDIKgVCfK9T8CoS51RDKeOjBM=
|
||||
github.com/hashicorp/go-discover v0.0.0-20191202160150-7ec2cfbda7a2/go.mod h1:NnH5X4UCBEBdTuK2L8s4e4ilJm3UmGX0bANHCz0HSs0=
|
||||
github.com/hashicorp/go-hclog v0.0.0-20180709165350-ff2cf002a8dd/go.mod h1:9bjs9uLqI8l75knNv3lV1kA55veR+WUPSiKIWcQHudI=
|
||||
github.com/hashicorp/go-hclog v0.8.0/go.mod h1:5CU+agLiy3J7N7QjHK5d05KxGsuXiQLrjA0H7acj2lQ=
|
||||
github.com/hashicorp/go-hclog v0.9.1 h1:9PZfAcVEvez4yhLH2TBU64/h/z4xlFI80cWXRrxuKuM=
|
||||
|
|
@ -207,8 +208,6 @@ github.com/imdario/mergo v0.3.6 h1:xTNEAn+kxVO7dTZGu0CegyqKZmoWFI0rF8UxjlB2d28=
|
|||
github.com/imdario/mergo v0.3.6/go.mod h1:2EnlNZ0deacrJVfApfmtdGgDfMuh/nq6Ok1EcJh5FfA=
|
||||
github.com/jarcoal/httpmock v0.0.0-20180424175123-9c70cfe4a1da h1:FjHUJJ7oBW4G/9j1KzlHaXL09LyMVM9rupS39lncbXk=
|
||||
github.com/jarcoal/httpmock v0.0.0-20180424175123-9c70cfe4a1da/go.mod h1:ks+b9deReOc7jgqp+e7LuFiCBH6Rm5hL32cLcEAArb4=
|
||||
github.com/jmespath/go-jmespath v0.0.0-20160202185014-0b12d6b521d8 h1:12VvqtR6Aowv3l/EQUlocDHW2Cp4G9WJVH7uyH8QFJE=
|
||||
github.com/jmespath/go-jmespath v0.0.0-20160202185014-0b12d6b521d8/go.mod h1:Nht3zPeWKUH0NzdCt2Blrr5ys8VGpn0CEB0cQHVjt7k=
|
||||
github.com/jmespath/go-jmespath v0.0.0-20180206201540-c2b33e8439af h1:pmfjZENx5imkbgOkpRUYLnmbU7UEFbjtDA2hxJ1ichM=
|
||||
github.com/jmespath/go-jmespath v0.0.0-20180206201540-c2b33e8439af/go.mod h1:Nht3zPeWKUH0NzdCt2Blrr5ys8VGpn0CEB0cQHVjt7k=
|
||||
github.com/joyent/triton-go v0.0.0-20180628001255-830d2b111e62 h1:JHCT6xuyPUrbbgAPE/3dqlvUKzRHMNuTBKKUb6OeR/k=
|
||||
|
|
@ -225,6 +224,15 @@ github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORN
|
|||
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
|
||||
github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
|
||||
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
|
||||
github.com/likexian/gokit v0.0.0-20190309162924-0a377eecf7aa/go.mod h1:QdfYv6y6qPA9pbBA2qXtoT8BMKha6UyNbxWGWl/9Jfk=
|
||||
github.com/likexian/gokit v0.0.0-20190418170008-ace88ad0983b/go.mod h1:KKqSnk/VVSW8kEyO2vVCXoanzEutKdlBAPohmGXkxCk=
|
||||
github.com/likexian/gokit v0.0.0-20190501133040-e77ea8b19cdc/go.mod h1:3kvONayqCaj+UgrRZGpgfXzHdMYCAO0KAt4/8n0L57Y=
|
||||
github.com/likexian/gokit v0.20.16/go.mod h1:kn+nTv3tqh6yhor9BC4Lfiu58SmH8NmQ2PmEl+uM6nU=
|
||||
github.com/likexian/simplejson-go v0.0.0-20190409170913-40473a74d76d/go.mod h1:Typ1BfnATYtZ/+/shXfFYLrovhFyuKvzwrdOnIDHlmg=
|
||||
github.com/likexian/simplejson-go v0.0.0-20190419151922-c1f9f0b4f084/go.mod h1:U4O1vIJvIKwbMZKUJ62lppfdvkCdVd2nfMimHK81eec=
|
||||
github.com/likexian/simplejson-go v0.0.0-20190502021454-d8787b4bfa0b/go.mod h1:3BWwtmKP9cXWwYCr5bkoVDEfLywacOv0s06OBEDpyt8=
|
||||
github.com/linode/linodego v0.7.1 h1:4WZmMpSA2NRwlPZcc0+4Gyn7rr99Evk9bnr0B3gXRKE=
|
||||
github.com/linode/linodego v0.7.1/go.mod h1:ga11n3ivecUrPCHN0rANxKmfWBJVkOXfLMZinAbj2sY=
|
||||
github.com/mattn/go-colorable v0.0.9 h1:UVL0vNpWh04HeJXV0KLcaT7r06gOH2l4OW6ddYRUIY4=
|
||||
github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
|
||||
github.com/mattn/go-isatty v0.0.3 h1:ns/ykhmWi7G9O+8a448SecJU3nSMBXJfqQkl0upE1jI=
|
||||
|
|
@ -328,6 +336,8 @@ github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1
|
|||
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
|
||||
github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
|
||||
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
|
||||
github.com/tencentcloud/tencentcloud-sdk-go v3.0.83+incompatible h1:8uRvJleFpqLsO77WaAh2UrasMOzd8MxXrNj20e7El+Q=
|
||||
github.com/tencentcloud/tencentcloud-sdk-go v3.0.83+incompatible/go.mod h1:0PfYow01SHPMhKY31xa+EFz2RStxIqj6JFAJS+IkCi4=
|
||||
github.com/tent/http-link-go v0.0.0-20130702225549-ac974c61c2f9 h1:/Bsw4C+DEdqPjt8vAqaC9LAqpAQnaCQQqmolqq3S1T4=
|
||||
github.com/tent/http-link-go v0.0.0-20130702225549-ac974c61c2f9/go.mod h1:RHkNRtSLfOK7qBTHaeSX1D6BNpI3qw7NTxsmNr4RvN8=
|
||||
github.com/tv42/httpunix v0.0.0-20150427012821-b75d8614f926 h1:G3dpKMzFDjgEh2q1Z7zUUtKa8ViPtH+ocF0bE0g00O8=
|
||||
|
|
@ -350,6 +360,7 @@ golang.org/x/net v0.0.0-20181023162649-9b4f9f5ad519 h1:x6rhz8Y9CjbgQkccRGmELH6K+
|
|||
golang.org/x/net v0.0.0-20181023162649-9b4f9f5ad519/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
golang.org/x/net v0.0.0-20181201002055-351d144fa1fc h1:a3CU5tJYVj92DY2LaA1kUkrsqD5/3mLDhx2NcNqyW+0=
|
||||
golang.org/x/net v0.0.0-20181201002055-351d144fa1fc/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
golang.org/x/net v0.0.0-20181220203305-927f97764cc3/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
||||
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
||||
|
|
@ -425,6 +436,8 @@ gopkg.in/gemnasium/logrus-airbrake-hook.v2 v2.1.2 h1:OAj3g0cR6Dx/R07QgQe8wkA9RNj
|
|||
gopkg.in/gemnasium/logrus-airbrake-hook.v2 v2.1.2/go.mod h1:Xk6kEKp8OKb+X14hQBKWaSkCsqBpgog8nAV2xsGOxlo=
|
||||
gopkg.in/inf.v0 v0.9.1 h1:73M5CoZyi3ZLMOyDlQh031Cx6N9NDJ2Vvfl76EDAgDc=
|
||||
gopkg.in/inf.v0 v0.9.1/go.mod h1:cWUDdTG/fYaXco+Dcufb5Vnc6Gp2YChqWtbxRZE0mXw=
|
||||
gopkg.in/resty.v1 v1.12.0 h1:CuXP0Pjfw9rOuY6EP+UvtNvt5DSqHpIxILZKT/quCZI=
|
||||
gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo=
|
||||
gopkg.in/square/go-jose.v2 v2.3.1 h1:SK5KegNXmKmqE342YYN2qPHEnUYeoMiXXl1poUlI+o4=
|
||||
gopkg.in/square/go-jose.v2 v2.3.1/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76mk0e1AI=
|
||||
gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ=
|
||||
|
|
|
|||
|
|
@ -0,0 +1,444 @@
|
|||
package auth
|
||||
|
||||
// Copyright 2017 Microsoft Corporation
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"crypto/rsa"
|
||||
"crypto/x509"
|
||||
"encoding/binary"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"log"
|
||||
"os"
|
||||
"strings"
|
||||
"unicode/utf16"
|
||||
|
||||
"github.com/Azure/go-autorest/autorest"
|
||||
"github.com/Azure/go-autorest/autorest/adal"
|
||||
"github.com/Azure/go-autorest/autorest/azure"
|
||||
"github.com/dimchansky/utfbom"
|
||||
"golang.org/x/crypto/pkcs12"
|
||||
)
|
||||
|
||||
// NewAuthorizerFromEnvironment creates an Authorizer configured from environment variables in the order:
|
||||
// 1. Client credentials
|
||||
// 2. Client certificate
|
||||
// 3. Username password
|
||||
// 4. MSI
|
||||
func NewAuthorizerFromEnvironment() (autorest.Authorizer, error) {
|
||||
settings, err := getAuthenticationSettings()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if settings.resource == "" {
|
||||
settings.resource = settings.environment.ResourceManagerEndpoint
|
||||
}
|
||||
|
||||
return settings.getAuthorizer()
|
||||
}
|
||||
|
||||
// NewAuthorizerFromEnvironmentWithResource creates an Authorizer configured from environment variables in the order:
|
||||
// 1. Client credentials
|
||||
// 2. Client certificate
|
||||
// 3. Username password
|
||||
// 4. MSI
|
||||
func NewAuthorizerFromEnvironmentWithResource(resource string) (autorest.Authorizer, error) {
|
||||
settings, err := getAuthenticationSettings()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
settings.resource = resource
|
||||
return settings.getAuthorizer()
|
||||
}
|
||||
|
||||
type settings struct {
|
||||
tenantID string
|
||||
clientID string
|
||||
clientSecret string
|
||||
certificatePath string
|
||||
certificatePassword string
|
||||
username string
|
||||
password string
|
||||
envName string
|
||||
resource string
|
||||
environment azure.Environment
|
||||
}
|
||||
|
||||
func getAuthenticationSettings() (s settings, err error) {
|
||||
s = settings{
|
||||
tenantID: os.Getenv("AZURE_TENANT_ID"),
|
||||
clientID: os.Getenv("AZURE_CLIENT_ID"),
|
||||
clientSecret: os.Getenv("AZURE_CLIENT_SECRET"),
|
||||
certificatePath: os.Getenv("AZURE_CERTIFICATE_PATH"),
|
||||
certificatePassword: os.Getenv("AZURE_CERTIFICATE_PASSWORD"),
|
||||
username: os.Getenv("AZURE_USERNAME"),
|
||||
password: os.Getenv("AZURE_PASSWORD"),
|
||||
envName: os.Getenv("AZURE_ENVIRONMENT"),
|
||||
resource: os.Getenv("AZURE_AD_RESOURCE"),
|
||||
}
|
||||
|
||||
if s.envName == "" {
|
||||
s.environment = azure.PublicCloud
|
||||
} else {
|
||||
s.environment, err = azure.EnvironmentFromName(s.envName)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
func (settings settings) getAuthorizer() (autorest.Authorizer, error) {
|
||||
//1.Client Credentials
|
||||
if settings.clientSecret != "" {
|
||||
config := NewClientCredentialsConfig(settings.clientID, settings.clientSecret, settings.tenantID)
|
||||
config.AADEndpoint = settings.environment.ActiveDirectoryEndpoint
|
||||
config.Resource = settings.resource
|
||||
return config.Authorizer()
|
||||
}
|
||||
|
||||
//2. Client Certificate
|
||||
if settings.certificatePath != "" {
|
||||
config := NewClientCertificateConfig(settings.certificatePath, settings.certificatePassword, settings.clientID, settings.tenantID)
|
||||
config.AADEndpoint = settings.environment.ActiveDirectoryEndpoint
|
||||
config.Resource = settings.resource
|
||||
return config.Authorizer()
|
||||
}
|
||||
|
||||
//3. Username Password
|
||||
if settings.username != "" && settings.password != "" {
|
||||
config := NewUsernamePasswordConfig(settings.username, settings.password, settings.clientID, settings.tenantID)
|
||||
config.AADEndpoint = settings.environment.ActiveDirectoryEndpoint
|
||||
config.Resource = settings.resource
|
||||
return config.Authorizer()
|
||||
}
|
||||
|
||||
// 4. MSI
|
||||
config := NewMSIConfig()
|
||||
config.Resource = settings.resource
|
||||
config.ClientID = settings.clientID
|
||||
return config.Authorizer()
|
||||
}
|
||||
|
||||
// NewAuthorizerFromFile creates an Authorizer configured from a configuration file.
|
||||
func NewAuthorizerFromFile(baseURI string) (autorest.Authorizer, error) {
|
||||
fileLocation := os.Getenv("AZURE_AUTH_LOCATION")
|
||||
if fileLocation == "" {
|
||||
return nil, errors.New("auth file not found. Environment variable AZURE_AUTH_LOCATION is not set")
|
||||
}
|
||||
|
||||
contents, err := ioutil.ReadFile(fileLocation)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Auth file might be encoded
|
||||
decoded, err := decode(contents)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
file := file{}
|
||||
err = json.Unmarshal(decoded, &file)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
resource, err := getResourceForToken(file, baseURI)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
config, err := adal.NewOAuthConfig(file.ActiveDirectoryEndpoint, file.TenantID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
spToken, err := adal.NewServicePrincipalToken(*config, file.ClientID, file.ClientSecret, resource)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return autorest.NewBearerAuthorizer(spToken), nil
|
||||
}
|
||||
|
||||
// File represents the authentication file
|
||||
type file struct {
|
||||
ClientID string `json:"clientId,omitempty"`
|
||||
ClientSecret string `json:"clientSecret,omitempty"`
|
||||
SubscriptionID string `json:"subscriptionId,omitempty"`
|
||||
TenantID string `json:"tenantId,omitempty"`
|
||||
ActiveDirectoryEndpoint string `json:"activeDirectoryEndpointUrl,omitempty"`
|
||||
ResourceManagerEndpoint string `json:"resourceManagerEndpointUrl,omitempty"`
|
||||
GraphResourceID string `json:"activeDirectoryGraphResourceId,omitempty"`
|
||||
SQLManagementEndpoint string `json:"sqlManagementEndpointUrl,omitempty"`
|
||||
GalleryEndpoint string `json:"galleryEndpointUrl,omitempty"`
|
||||
ManagementEndpoint string `json:"managementEndpointUrl,omitempty"`
|
||||
}
|
||||
|
||||
func decode(b []byte) ([]byte, error) {
|
||||
reader, enc := utfbom.Skip(bytes.NewReader(b))
|
||||
|
||||
switch enc {
|
||||
case utfbom.UTF16LittleEndian:
|
||||
u16 := make([]uint16, (len(b)/2)-1)
|
||||
err := binary.Read(reader, binary.LittleEndian, &u16)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return []byte(string(utf16.Decode(u16))), nil
|
||||
case utfbom.UTF16BigEndian:
|
||||
u16 := make([]uint16, (len(b)/2)-1)
|
||||
err := binary.Read(reader, binary.BigEndian, &u16)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return []byte(string(utf16.Decode(u16))), nil
|
||||
}
|
||||
return ioutil.ReadAll(reader)
|
||||
}
|
||||
|
||||
func getResourceForToken(f file, baseURI string) (string, error) {
|
||||
// Compare dafault base URI from the SDK to the endpoints from the public cloud
|
||||
// Base URI and token resource are the same string. This func finds the authentication
|
||||
// file field that matches the SDK base URI. The SDK defines the public cloud
|
||||
// endpoint as its default base URI
|
||||
if !strings.HasSuffix(baseURI, "/") {
|
||||
baseURI += "/"
|
||||
}
|
||||
switch baseURI {
|
||||
case azure.PublicCloud.ServiceManagementEndpoint:
|
||||
return f.ManagementEndpoint, nil
|
||||
case azure.PublicCloud.ResourceManagerEndpoint:
|
||||
return f.ResourceManagerEndpoint, nil
|
||||
case azure.PublicCloud.ActiveDirectoryEndpoint:
|
||||
return f.ActiveDirectoryEndpoint, nil
|
||||
case azure.PublicCloud.GalleryEndpoint:
|
||||
return f.GalleryEndpoint, nil
|
||||
case azure.PublicCloud.GraphEndpoint:
|
||||
return f.GraphResourceID, nil
|
||||
}
|
||||
return "", fmt.Errorf("auth: base URI not found in endpoints")
|
||||
}
|
||||
|
||||
// NewClientCredentialsConfig creates an AuthorizerConfig object configured to obtain an Authorizer through Client Credentials.
|
||||
// Defaults to Public Cloud and Resource Manager Endpoint.
|
||||
func NewClientCredentialsConfig(clientID string, clientSecret string, tenantID string) ClientCredentialsConfig {
|
||||
return ClientCredentialsConfig{
|
||||
ClientID: clientID,
|
||||
ClientSecret: clientSecret,
|
||||
TenantID: tenantID,
|
||||
Resource: azure.PublicCloud.ResourceManagerEndpoint,
|
||||
AADEndpoint: azure.PublicCloud.ActiveDirectoryEndpoint,
|
||||
}
|
||||
}
|
||||
|
||||
// NewClientCertificateConfig creates a ClientCertificateConfig object configured to obtain an Authorizer through client certificate.
|
||||
// Defaults to Public Cloud and Resource Manager Endpoint.
|
||||
func NewClientCertificateConfig(certificatePath string, certificatePassword string, clientID string, tenantID string) ClientCertificateConfig {
|
||||
return ClientCertificateConfig{
|
||||
CertificatePath: certificatePath,
|
||||
CertificatePassword: certificatePassword,
|
||||
ClientID: clientID,
|
||||
TenantID: tenantID,
|
||||
Resource: azure.PublicCloud.ResourceManagerEndpoint,
|
||||
AADEndpoint: azure.PublicCloud.ActiveDirectoryEndpoint,
|
||||
}
|
||||
}
|
||||
|
||||
// NewUsernamePasswordConfig creates an UsernamePasswordConfig object configured to obtain an Authorizer through username and password.
|
||||
// Defaults to Public Cloud and Resource Manager Endpoint.
|
||||
func NewUsernamePasswordConfig(username string, password string, clientID string, tenantID string) UsernamePasswordConfig {
|
||||
return UsernamePasswordConfig{
|
||||
Username: username,
|
||||
Password: password,
|
||||
ClientID: clientID,
|
||||
TenantID: tenantID,
|
||||
Resource: azure.PublicCloud.ResourceManagerEndpoint,
|
||||
AADEndpoint: azure.PublicCloud.ActiveDirectoryEndpoint,
|
||||
}
|
||||
}
|
||||
|
||||
// NewMSIConfig creates an MSIConfig object configured to obtain an Authorizer through MSI.
|
||||
func NewMSIConfig() MSIConfig {
|
||||
return MSIConfig{
|
||||
Resource: azure.PublicCloud.ResourceManagerEndpoint,
|
||||
}
|
||||
}
|
||||
|
||||
// NewDeviceFlowConfig creates a DeviceFlowConfig object configured to obtain an Authorizer through device flow.
|
||||
// Defaults to Public Cloud and Resource Manager Endpoint.
|
||||
func NewDeviceFlowConfig(clientID string, tenantID string) DeviceFlowConfig {
|
||||
return DeviceFlowConfig{
|
||||
ClientID: clientID,
|
||||
TenantID: tenantID,
|
||||
Resource: azure.PublicCloud.ResourceManagerEndpoint,
|
||||
AADEndpoint: azure.PublicCloud.ActiveDirectoryEndpoint,
|
||||
}
|
||||
}
|
||||
|
||||
//AuthorizerConfig provides an authorizer from the configuration provided.
|
||||
type AuthorizerConfig interface {
|
||||
Authorizer() (autorest.Authorizer, error)
|
||||
}
|
||||
|
||||
// ClientCredentialsConfig provides the options to get a bearer authorizer from client credentials.
|
||||
type ClientCredentialsConfig struct {
|
||||
ClientID string
|
||||
ClientSecret string
|
||||
TenantID string
|
||||
AADEndpoint string
|
||||
Resource string
|
||||
}
|
||||
|
||||
// Authorizer gets the authorizer from client credentials.
|
||||
func (ccc ClientCredentialsConfig) Authorizer() (autorest.Authorizer, error) {
|
||||
oauthConfig, err := adal.NewOAuthConfig(ccc.AADEndpoint, ccc.TenantID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
spToken, err := adal.NewServicePrincipalToken(*oauthConfig, ccc.ClientID, ccc.ClientSecret, ccc.Resource)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to get oauth token from client credentials: %v", err)
|
||||
}
|
||||
|
||||
return autorest.NewBearerAuthorizer(spToken), nil
|
||||
}
|
||||
|
||||
// ClientCertificateConfig provides the options to get a bearer authorizer from a client certificate.
|
||||
type ClientCertificateConfig struct {
|
||||
ClientID string
|
||||
CertificatePath string
|
||||
CertificatePassword string
|
||||
TenantID string
|
||||
AADEndpoint string
|
||||
Resource string
|
||||
}
|
||||
|
||||
// Authorizer gets an authorizer object from client certificate.
|
||||
func (ccc ClientCertificateConfig) Authorizer() (autorest.Authorizer, error) {
|
||||
oauthConfig, err := adal.NewOAuthConfig(ccc.AADEndpoint, ccc.TenantID)
|
||||
|
||||
certData, err := ioutil.ReadFile(ccc.CertificatePath)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to read the certificate file (%s): %v", ccc.CertificatePath, err)
|
||||
}
|
||||
|
||||
certificate, rsaPrivateKey, err := decodePkcs12(certData, ccc.CertificatePassword)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to decode pkcs12 certificate while creating spt: %v", err)
|
||||
}
|
||||
|
||||
spToken, err := adal.NewServicePrincipalTokenFromCertificate(*oauthConfig, ccc.ClientID, certificate, rsaPrivateKey, ccc.Resource)
|
||||
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to get oauth token from certificate auth: %v", err)
|
||||
}
|
||||
|
||||
return autorest.NewBearerAuthorizer(spToken), nil
|
||||
}
|
||||
|
||||
// DeviceFlowConfig provides the options to get a bearer authorizer using device flow authentication.
|
||||
type DeviceFlowConfig struct {
|
||||
ClientID string
|
||||
TenantID string
|
||||
AADEndpoint string
|
||||
Resource string
|
||||
}
|
||||
|
||||
// Authorizer gets the authorizer from device flow.
|
||||
func (dfc DeviceFlowConfig) Authorizer() (autorest.Authorizer, error) {
|
||||
oauthClient := &autorest.Client{}
|
||||
oauthConfig, err := adal.NewOAuthConfig(dfc.AADEndpoint, dfc.TenantID)
|
||||
deviceCode, err := adal.InitiateDeviceAuth(oauthClient, *oauthConfig, dfc.ClientID, dfc.Resource)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to start device auth flow: %s", err)
|
||||
}
|
||||
|
||||
log.Println(*deviceCode.Message)
|
||||
|
||||
token, err := adal.WaitForUserCompletion(oauthClient, deviceCode)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to finish device auth flow: %s", err)
|
||||
}
|
||||
|
||||
spToken, err := adal.NewServicePrincipalTokenFromManualToken(*oauthConfig, dfc.ClientID, dfc.Resource, *token)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to get oauth token from device flow: %v", err)
|
||||
}
|
||||
|
||||
return autorest.NewBearerAuthorizer(spToken), nil
|
||||
}
|
||||
|
||||
func decodePkcs12(pkcs []byte, password string) (*x509.Certificate, *rsa.PrivateKey, error) {
|
||||
privateKey, certificate, err := pkcs12.Decode(pkcs, password)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
|
||||
rsaPrivateKey, isRsaKey := privateKey.(*rsa.PrivateKey)
|
||||
if !isRsaKey {
|
||||
return nil, nil, fmt.Errorf("PKCS#12 certificate must contain an RSA private key")
|
||||
}
|
||||
|
||||
return certificate, rsaPrivateKey, nil
|
||||
}
|
||||
|
||||
// UsernamePasswordConfig provides the options to get a bearer authorizer from a username and a password.
|
||||
type UsernamePasswordConfig struct {
|
||||
ClientID string
|
||||
Username string
|
||||
Password string
|
||||
TenantID string
|
||||
AADEndpoint string
|
||||
Resource string
|
||||
}
|
||||
|
||||
// Authorizer gets the authorizer from a username and a password.
|
||||
func (ups UsernamePasswordConfig) Authorizer() (autorest.Authorizer, error) {
|
||||
|
||||
oauthConfig, err := adal.NewOAuthConfig(ups.AADEndpoint, ups.TenantID)
|
||||
|
||||
spToken, err := adal.NewServicePrincipalTokenFromUsernamePassword(*oauthConfig, ups.ClientID, ups.Username, ups.Password, ups.Resource)
|
||||
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to get oauth token from username and password auth: %v", err)
|
||||
}
|
||||
|
||||
return autorest.NewBearerAuthorizer(spToken), nil
|
||||
}
|
||||
|
||||
// MSIConfig provides the options to get a bearer authorizer through MSI.
|
||||
type MSIConfig struct {
|
||||
Resource string
|
||||
ClientID string
|
||||
}
|
||||
|
||||
// Authorizer gets the authorizer from MSI.
|
||||
func (mc MSIConfig) Authorizer() (autorest.Authorizer, error) {
|
||||
msiEndpoint, err := adal.GetMSIVMEndpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
spToken, err := adal.NewServicePrincipalTokenFromMSI(msiEndpoint, mc.Resource)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to get oauth token from MSI: %v", err)
|
||||
}
|
||||
|
||||
return autorest.NewBearerAuthorizer(spToken), nil
|
||||
}
|
||||
|
|
@ -70,7 +70,7 @@ func rValuesAtPath(v interface{}, path string, createPath, caseSensitive, nilTer
|
|||
value = value.FieldByNameFunc(func(name string) bool {
|
||||
if c == name {
|
||||
return true
|
||||
} else if !caseSensitive && strings.ToLower(name) == strings.ToLower(c) {
|
||||
} else if !caseSensitive && strings.EqualFold(name, c) {
|
||||
return true
|
||||
}
|
||||
return false
|
||||
|
|
|
|||
|
|
@ -249,6 +249,9 @@ type Config struct {
|
|||
|
||||
// STSRegionalEndpoint will enable regional or legacy endpoint resolving
|
||||
STSRegionalEndpoint endpoints.STSRegionalEndpoint
|
||||
|
||||
// S3UsEast1RegionalEndpoint will enable regional or legacy endpoint resolving
|
||||
S3UsEast1RegionalEndpoint endpoints.S3UsEast1RegionalEndpoint
|
||||
}
|
||||
|
||||
// NewConfig returns a new Config pointer that can be chained with builder
|
||||
|
|
@ -430,6 +433,13 @@ func (c *Config) WithSTSRegionalEndpoint(sre endpoints.STSRegionalEndpoint) *Con
|
|||
return c
|
||||
}
|
||||
|
||||
// WithS3UsEast1RegionalEndpoint will set whether or not to use regional endpoint flag
|
||||
// when resolving the endpoint for a service
|
||||
func (c *Config) WithS3UsEast1RegionalEndpoint(sre endpoints.S3UsEast1RegionalEndpoint) *Config {
|
||||
c.S3UsEast1RegionalEndpoint = sre
|
||||
return c
|
||||
}
|
||||
|
||||
func mergeInConfig(dst *Config, other *Config) {
|
||||
if other == nil {
|
||||
return
|
||||
|
|
@ -534,6 +544,10 @@ func mergeInConfig(dst *Config, other *Config) {
|
|||
if other.STSRegionalEndpoint != endpoints.UnsetSTSEndpoint {
|
||||
dst.STSRegionalEndpoint = other.STSRegionalEndpoint
|
||||
}
|
||||
|
||||
if other.S3UsEast1RegionalEndpoint != endpoints.UnsetS3UsEast1Endpoint {
|
||||
dst.S3UsEast1RegionalEndpoint = other.S3UsEast1RegionalEndpoint
|
||||
}
|
||||
}
|
||||
|
||||
// Copy will return a shallow copy of the Config object. If any additional
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ import (
|
|||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
|
|
@ -12,8 +13,41 @@ import (
|
|||
"github.com/aws/aws-sdk-go/internal/sdkuri"
|
||||
)
|
||||
|
||||
// getToken uses the duration to return a token for EC2 metadata service,
|
||||
// or an error if the request failed.
|
||||
func (c *EC2Metadata) getToken(duration time.Duration) (tokenOutput, error) {
|
||||
op := &request.Operation{
|
||||
Name: "GetToken",
|
||||
HTTPMethod: "PUT",
|
||||
HTTPPath: "/api/token",
|
||||
}
|
||||
|
||||
var output tokenOutput
|
||||
req := c.NewRequest(op, nil, &output)
|
||||
|
||||
// remove the fetch token handler from the request handlers to avoid infinite recursion
|
||||
req.Handlers.Sign.RemoveByName(fetchTokenHandlerName)
|
||||
|
||||
// Swap the unmarshalMetadataHandler with unmarshalTokenHandler on this request.
|
||||
req.Handlers.Unmarshal.Swap(unmarshalMetadataHandlerName, unmarshalTokenHandler)
|
||||
|
||||
ttl := strconv.FormatInt(int64(duration / time.Second),10)
|
||||
req.HTTPRequest.Header.Set(ttlHeader, ttl)
|
||||
|
||||
err := req.Send()
|
||||
|
||||
// Errors with bad request status should be returned.
|
||||
if err != nil {
|
||||
err = awserr.NewRequestFailure(
|
||||
awserr.New(req.HTTPResponse.Status, http.StatusText(req.HTTPResponse.StatusCode), err),
|
||||
req.HTTPResponse.StatusCode, req.RequestID)
|
||||
}
|
||||
|
||||
return output, err
|
||||
}
|
||||
|
||||
// GetMetadata uses the path provided to request information from the EC2
|
||||
// instance metdata service. The content will be returned as a string, or
|
||||
// instance metadata service. The content will be returned as a string, or
|
||||
// error if the request failed.
|
||||
func (c *EC2Metadata) GetMetadata(p string) (string, error) {
|
||||
op := &request.Operation{
|
||||
|
|
@ -21,11 +55,11 @@ func (c *EC2Metadata) GetMetadata(p string) (string, error) {
|
|||
HTTPMethod: "GET",
|
||||
HTTPPath: sdkuri.PathJoin("/meta-data", p),
|
||||
}
|
||||
|
||||
output := &metadataOutput{}
|
||||
req := c.NewRequest(op, nil, output)
|
||||
err := req.Send()
|
||||
|
||||
req := c.NewRequest(op, nil, output)
|
||||
|
||||
err := req.Send()
|
||||
return output.Content, err
|
||||
}
|
||||
|
||||
|
|
@ -41,13 +75,8 @@ func (c *EC2Metadata) GetUserData() (string, error) {
|
|||
|
||||
output := &metadataOutput{}
|
||||
req := c.NewRequest(op, nil, output)
|
||||
req.Handlers.UnmarshalError.PushBack(func(r *request.Request) {
|
||||
if r.HTTPResponse.StatusCode == http.StatusNotFound {
|
||||
r.Error = awserr.New("NotFoundError", "user-data not found", r.Error)
|
||||
}
|
||||
})
|
||||
err := req.Send()
|
||||
|
||||
err := req.Send()
|
||||
return output.Content, err
|
||||
}
|
||||
|
||||
|
|
@ -63,8 +92,8 @@ func (c *EC2Metadata) GetDynamicData(p string) (string, error) {
|
|||
|
||||
output := &metadataOutput{}
|
||||
req := c.NewRequest(op, nil, output)
|
||||
err := req.Send()
|
||||
|
||||
err := req.Send()
|
||||
return output.Content, err
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ import (
|
|||
"io"
|
||||
"net/http"
|
||||
"os"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
|
|
@ -24,9 +25,25 @@ import (
|
|||
"github.com/aws/aws-sdk-go/aws/request"
|
||||
)
|
||||
|
||||
// ServiceName is the name of the service.
|
||||
const ServiceName = "ec2metadata"
|
||||
const disableServiceEnvVar = "AWS_EC2_METADATA_DISABLED"
|
||||
const (
|
||||
// ServiceName is the name of the service.
|
||||
ServiceName = "ec2metadata"
|
||||
disableServiceEnvVar = "AWS_EC2_METADATA_DISABLED"
|
||||
|
||||
// Headers for Token and TTL
|
||||
ttlHeader = "x-aws-ec2-metadata-token-ttl-seconds"
|
||||
tokenHeader = "x-aws-ec2-metadata-token"
|
||||
|
||||
// Named Handler constants
|
||||
fetchTokenHandlerName = "FetchTokenHandler"
|
||||
unmarshalMetadataHandlerName = "unmarshalMetadataHandler"
|
||||
unmarshalTokenHandlerName = "unmarshalTokenHandler"
|
||||
enableTokenProviderHandlerName = "enableTokenProviderHandler"
|
||||
|
||||
// TTL constants
|
||||
defaultTTL = 21600 * time.Second
|
||||
ttlExpirationWindow = 30 * time.Second
|
||||
)
|
||||
|
||||
// A EC2Metadata is an EC2 Metadata service Client.
|
||||
type EC2Metadata struct {
|
||||
|
|
@ -80,13 +97,27 @@ func NewClient(cfg aws.Config, handlers request.Handlers, endpoint, signingRegio
|
|||
),
|
||||
}
|
||||
|
||||
svc.Handlers.Unmarshal.PushBack(unmarshalHandler)
|
||||
// token provider instance
|
||||
tp := newTokenProvider(svc, defaultTTL)
|
||||
|
||||
// NamedHandler for fetching token
|
||||
svc.Handlers.Sign.PushBackNamed(request.NamedHandler{
|
||||
Name: fetchTokenHandlerName,
|
||||
Fn: tp.fetchTokenHandler,
|
||||
})
|
||||
// NamedHandler for enabling token provider
|
||||
svc.Handlers.Complete.PushBackNamed(request.NamedHandler{
|
||||
Name: enableTokenProviderHandlerName,
|
||||
Fn: tp.enableTokenProviderHandler,
|
||||
})
|
||||
|
||||
svc.Handlers.Unmarshal.PushBackNamed(unmarshalHandler)
|
||||
svc.Handlers.UnmarshalError.PushBack(unmarshalError)
|
||||
svc.Handlers.Validate.Clear()
|
||||
svc.Handlers.Validate.PushBack(validateEndpointHandler)
|
||||
|
||||
// Disable the EC2 Metadata service if the environment variable is set.
|
||||
// This shortcirctes the service's functionality to always fail to send
|
||||
// This short-circuits the service's functionality to always fail to send
|
||||
// requests.
|
||||
if strings.ToLower(os.Getenv(disableServiceEnvVar)) == "true" {
|
||||
svc.Handlers.Send.SwapNamed(request.NamedHandler{
|
||||
|
|
@ -107,7 +138,6 @@ func NewClient(cfg aws.Config, handlers request.Handlers, endpoint, signingRegio
|
|||
for _, option := range opts {
|
||||
option(svc.Client)
|
||||
}
|
||||
|
||||
return svc
|
||||
}
|
||||
|
||||
|
|
@ -119,30 +149,74 @@ type metadataOutput struct {
|
|||
Content string
|
||||
}
|
||||
|
||||
func unmarshalHandler(r *request.Request) {
|
||||
defer r.HTTPResponse.Body.Close()
|
||||
b := &bytes.Buffer{}
|
||||
if _, err := io.Copy(b, r.HTTPResponse.Body); err != nil {
|
||||
r.Error = awserr.New(request.ErrCodeSerialization, "unable to unmarshal EC2 metadata response", err)
|
||||
return
|
||||
}
|
||||
type tokenOutput struct {
|
||||
Token string
|
||||
TTL time.Duration
|
||||
}
|
||||
|
||||
if data, ok := r.Data.(*metadataOutput); ok {
|
||||
data.Content = b.String()
|
||||
}
|
||||
// unmarshal token handler is used to parse the response of a getToken operation
|
||||
var unmarshalTokenHandler = request.NamedHandler{
|
||||
Name: unmarshalTokenHandlerName,
|
||||
Fn: func(r *request.Request) {
|
||||
defer r.HTTPResponse.Body.Close()
|
||||
var b bytes.Buffer
|
||||
if _, err := io.Copy(&b, r.HTTPResponse.Body); err != nil {
|
||||
r.Error = awserr.NewRequestFailure(awserr.New(request.ErrCodeSerialization,
|
||||
"unable to unmarshal EC2 metadata response", err), r.HTTPResponse.StatusCode, r.RequestID)
|
||||
return
|
||||
}
|
||||
|
||||
v := r.HTTPResponse.Header.Get(ttlHeader)
|
||||
data, ok := r.Data.(*tokenOutput)
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
|
||||
data.Token = b.String()
|
||||
// TTL is in seconds
|
||||
i, err := strconv.ParseInt(v, 10, 64)
|
||||
if err != nil {
|
||||
r.Error = awserr.NewRequestFailure(awserr.New(request.ParamFormatErrCode,
|
||||
"unable to parse EC2 token TTL response", err), r.HTTPResponse.StatusCode, r.RequestID)
|
||||
return
|
||||
}
|
||||
t := time.Duration(i) * time.Second
|
||||
data.TTL = t
|
||||
},
|
||||
}
|
||||
|
||||
var unmarshalHandler = request.NamedHandler{
|
||||
Name: unmarshalMetadataHandlerName,
|
||||
Fn: func(r *request.Request) {
|
||||
defer r.HTTPResponse.Body.Close()
|
||||
var b bytes.Buffer
|
||||
if _, err := io.Copy(&b, r.HTTPResponse.Body); err != nil {
|
||||
r.Error = awserr.NewRequestFailure(awserr.New(request.ErrCodeSerialization,
|
||||
"unable to unmarshal EC2 metadata response", err), r.HTTPResponse.StatusCode, r.RequestID)
|
||||
return
|
||||
}
|
||||
|
||||
if data, ok := r.Data.(*metadataOutput); ok {
|
||||
data.Content = b.String()
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
func unmarshalError(r *request.Request) {
|
||||
defer r.HTTPResponse.Body.Close()
|
||||
b := &bytes.Buffer{}
|
||||
if _, err := io.Copy(b, r.HTTPResponse.Body); err != nil {
|
||||
r.Error = awserr.New(request.ErrCodeSerialization, "unable to unmarshal EC2 metadata error response", err)
|
||||
var b bytes.Buffer
|
||||
|
||||
if _, err := io.Copy(&b, r.HTTPResponse.Body); err != nil {
|
||||
r.Error = awserr.NewRequestFailure(
|
||||
awserr.New(request.ErrCodeSerialization, "unable to unmarshal EC2 metadata error response", err),
|
||||
r.HTTPResponse.StatusCode, r.RequestID)
|
||||
return
|
||||
}
|
||||
|
||||
// Response body format is not consistent between metadata endpoints.
|
||||
// Grab the error message as a string and include that as the source error
|
||||
r.Error = awserr.New("EC2MetadataError", "failed to make EC2Metadata request", errors.New(b.String()))
|
||||
r.Error = awserr.NewRequestFailure(awserr.New("EC2MetadataError", "failed to make EC2Metadata request", errors.New(b.String())),
|
||||
r.HTTPResponse.StatusCode, r.RequestID)
|
||||
}
|
||||
|
||||
func validateEndpointHandler(r *request.Request) {
|
||||
|
|
|
|||
92
vendor/github.com/aws/aws-sdk-go/aws/ec2metadata/token_provider.go
generated
vendored
Normal file
92
vendor/github.com/aws/aws-sdk-go/aws/ec2metadata/token_provider.go
generated
vendored
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
package ec2metadata
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"sync/atomic"
|
||||
"time"
|
||||
|
||||
"github.com/aws/aws-sdk-go/aws/awserr"
|
||||
"github.com/aws/aws-sdk-go/aws/credentials"
|
||||
"github.com/aws/aws-sdk-go/aws/request"
|
||||
)
|
||||
|
||||
// A tokenProvider struct provides access to EC2Metadata client
|
||||
// and atomic instance of a token, along with configuredTTL for it.
|
||||
// tokenProvider also provides an atomic flag to disable the
|
||||
// fetch token operation.
|
||||
// The disabled member will use 0 as false, and 1 as true.
|
||||
type tokenProvider struct {
|
||||
client *EC2Metadata
|
||||
token atomic.Value
|
||||
configuredTTL time.Duration
|
||||
disabled uint32
|
||||
}
|
||||
|
||||
// A ec2Token struct helps use of token in EC2 Metadata service ops
|
||||
type ec2Token struct {
|
||||
token string
|
||||
credentials.Expiry
|
||||
}
|
||||
|
||||
// newTokenProvider provides a pointer to a tokenProvider instance
|
||||
func newTokenProvider(c *EC2Metadata, duration time.Duration) *tokenProvider {
|
||||
return &tokenProvider{client: c, configuredTTL: duration}
|
||||
}
|
||||
|
||||
// fetchTokenHandler fetches token for EC2Metadata service client by default.
|
||||
func (t *tokenProvider) fetchTokenHandler(r *request.Request) {
|
||||
|
||||
// short-circuits to insecure data flow if tokenProvider is disabled.
|
||||
if v := atomic.LoadUint32(&t.disabled); v == 1 {
|
||||
return
|
||||
}
|
||||
|
||||
if ec2Token, ok := t.token.Load().(ec2Token); ok && !ec2Token.IsExpired() {
|
||||
r.HTTPRequest.Header.Set(tokenHeader, ec2Token.token)
|
||||
return
|
||||
}
|
||||
|
||||
output, err := t.client.getToken(t.configuredTTL)
|
||||
|
||||
if err != nil {
|
||||
|
||||
// change the disabled flag on token provider to true,
|
||||
// when error is request timeout error.
|
||||
if requestFailureError, ok := err.(awserr.RequestFailure); ok {
|
||||
switch requestFailureError.StatusCode() {
|
||||
case http.StatusForbidden, http.StatusNotFound, http.StatusMethodNotAllowed:
|
||||
atomic.StoreUint32(&t.disabled, 1)
|
||||
case http.StatusBadRequest:
|
||||
r.Error = requestFailureError
|
||||
}
|
||||
|
||||
// Check if request timed out while waiting for response
|
||||
if e, ok := requestFailureError.OrigErr().(awserr.Error); ok {
|
||||
if e.Code() == "RequestError" {
|
||||
atomic.StoreUint32(&t.disabled, 1)
|
||||
}
|
||||
}
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
newToken := ec2Token{
|
||||
token: output.Token,
|
||||
}
|
||||
newToken.SetExpiration(time.Now().Add(output.TTL), ttlExpirationWindow)
|
||||
t.token.Store(newToken)
|
||||
|
||||
// Inject token header to the request.
|
||||
if ec2Token, ok := t.token.Load().(ec2Token); ok {
|
||||
r.HTTPRequest.Header.Set(tokenHeader, ec2Token.token)
|
||||
}
|
||||
}
|
||||
|
||||
// enableTokenProviderHandler enables the token provider
|
||||
func (t *tokenProvider) enableTokenProviderHandler(r *request.Request) {
|
||||
// If the error code status is 401, we enable the token provider
|
||||
if e, ok := r.Error.(awserr.RequestFailure); ok && e != nil &&
|
||||
e.StatusCode() == http.StatusUnauthorized {
|
||||
atomic.StoreUint32(&t.disabled, 0)
|
||||
}
|
||||
}
|
||||
|
|
@ -83,6 +83,7 @@ func decodeV3Endpoints(modelDef modelDefinition, opts DecodeModelOptions) (Resol
|
|||
p := &ps[i]
|
||||
custAddEC2Metadata(p)
|
||||
custAddS3DualStack(p)
|
||||
custRegionalS3(p)
|
||||
custRmIotDataService(p)
|
||||
custFixAppAutoscalingChina(p)
|
||||
custFixAppAutoscalingUsGov(p)
|
||||
|
|
@ -100,6 +101,33 @@ func custAddS3DualStack(p *partition) {
|
|||
custAddDualstack(p, "s3-control")
|
||||
}
|
||||
|
||||
func custRegionalS3(p *partition) {
|
||||
if p.ID != "aws" {
|
||||
return
|
||||
}
|
||||
|
||||
service, ok := p.Services["s3"]
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
|
||||
// If global endpoint already exists no customization needed.
|
||||
if _, ok := service.Endpoints["aws-global"]; ok {
|
||||
return
|
||||
}
|
||||
|
||||
service.PartitionEndpoint = "aws-global"
|
||||
service.Endpoints["us-east-1"] = endpoint{}
|
||||
service.Endpoints["aws-global"] = endpoint{
|
||||
Hostname: "s3.amazonaws.com",
|
||||
CredentialScope: credentialScope{
|
||||
Region: "us-east-1",
|
||||
},
|
||||
}
|
||||
|
||||
p.Services["s3"] = service
|
||||
}
|
||||
|
||||
func custAddDualstack(p *partition, svcName string) {
|
||||
s, ok := p.Services[svcName]
|
||||
if !ok {
|
||||
|
|
|
|||
|
|
@ -425,11 +425,7 @@ var awsPartition = partition{
|
|||
},
|
||||
"application-autoscaling": service{
|
||||
Defaults: endpoint{
|
||||
Hostname: "autoscaling.{region}.amazonaws.com",
|
||||
Protocols: []string{"http", "https"},
|
||||
CredentialScope: credentialScope{
|
||||
Service: "application-autoscaling",
|
||||
},
|
||||
},
|
||||
Endpoints: endpoints{
|
||||
"ap-east-1": endpoint{},
|
||||
|
|
@ -560,11 +556,7 @@ var awsPartition = partition{
|
|||
},
|
||||
"autoscaling-plans": service{
|
||||
Defaults: endpoint{
|
||||
Hostname: "autoscaling.{region}.amazonaws.com",
|
||||
Protocols: []string{"http", "https"},
|
||||
CredentialScope: credentialScope{
|
||||
Service: "autoscaling-plans",
|
||||
},
|
||||
},
|
||||
Endpoints: endpoints{
|
||||
"ap-northeast-1": endpoint{},
|
||||
|
|
@ -1104,6 +1096,22 @@ var awsPartition = partition{
|
|||
"us-west-2": endpoint{},
|
||||
},
|
||||
},
|
||||
"dataexchange": service{
|
||||
|
||||
Endpoints: endpoints{
|
||||
"ap-northeast-1": endpoint{},
|
||||
"ap-northeast-2": endpoint{},
|
||||
"ap-southeast-1": endpoint{},
|
||||
"ap-southeast-2": endpoint{},
|
||||
"eu-central-1": endpoint{},
|
||||
"eu-west-1": endpoint{},
|
||||
"eu-west-2": endpoint{},
|
||||
"us-east-1": endpoint{},
|
||||
"us-east-2": endpoint{},
|
||||
"us-west-1": endpoint{},
|
||||
"us-west-2": endpoint{},
|
||||
},
|
||||
},
|
||||
"datapipeline": service{
|
||||
|
||||
Endpoints: endpoints{
|
||||
|
|
@ -1117,12 +1125,15 @@ var awsPartition = partition{
|
|||
"datasync": service{
|
||||
|
||||
Endpoints: endpoints{
|
||||
"ap-east-1": endpoint{},
|
||||
"ap-northeast-1": endpoint{},
|
||||
"ap-northeast-2": endpoint{},
|
||||
"ap-south-1": endpoint{},
|
||||
"ap-southeast-1": endpoint{},
|
||||
"ap-southeast-2": endpoint{},
|
||||
"ca-central-1": endpoint{},
|
||||
"eu-central-1": endpoint{},
|
||||
"eu-north-1": endpoint{},
|
||||
"eu-west-1": endpoint{},
|
||||
"eu-west-2": endpoint{},
|
||||
"eu-west-3": endpoint{},
|
||||
|
|
@ -1151,6 +1162,7 @@ var awsPartition = partition{
|
|||
},
|
||||
},
|
||||
"me-south-1": endpoint{},
|
||||
"sa-east-1": endpoint{},
|
||||
"us-east-1": endpoint{},
|
||||
"us-east-2": endpoint{},
|
||||
"us-west-1": endpoint{},
|
||||
|
|
@ -1166,6 +1178,8 @@ var awsPartition = partition{
|
|||
"ap-southeast-2": endpoint{},
|
||||
"eu-central-1": endpoint{},
|
||||
"eu-west-1": endpoint{},
|
||||
"eu-west-2": endpoint{},
|
||||
"eu-west-3": endpoint{},
|
||||
"sa-east-1": endpoint{},
|
||||
"us-east-1": endpoint{},
|
||||
"us-east-2": endpoint{},
|
||||
|
|
@ -1205,7 +1219,8 @@ var awsPartition = partition{
|
|||
"discovery": service{
|
||||
|
||||
Endpoints: endpoints{
|
||||
"us-west-2": endpoint{},
|
||||
"eu-central-1": endpoint{},
|
||||
"us-west-2": endpoint{},
|
||||
},
|
||||
},
|
||||
"dms": service{
|
||||
|
|
@ -1505,6 +1520,7 @@ var awsPartition = partition{
|
|||
"elasticfilesystem": service{
|
||||
|
||||
Endpoints: endpoints{
|
||||
"ap-east-1": endpoint{},
|
||||
"ap-northeast-1": endpoint{},
|
||||
"ap-northeast-2": endpoint{},
|
||||
"ap-south-1": endpoint{},
|
||||
|
|
@ -1512,9 +1528,12 @@ var awsPartition = partition{
|
|||
"ap-southeast-2": endpoint{},
|
||||
"ca-central-1": endpoint{},
|
||||
"eu-central-1": endpoint{},
|
||||
"eu-north-1": endpoint{},
|
||||
"eu-west-1": endpoint{},
|
||||
"eu-west-2": endpoint{},
|
||||
"eu-west-3": endpoint{},
|
||||
"me-south-1": endpoint{},
|
||||
"sa-east-1": endpoint{},
|
||||
"us-east-1": endpoint{},
|
||||
"us-east-2": endpoint{},
|
||||
"us-west-1": endpoint{},
|
||||
|
|
@ -1692,11 +1711,16 @@ var awsPartition = partition{
|
|||
Endpoints: endpoints{
|
||||
"ap-northeast-1": endpoint{},
|
||||
"ap-northeast-2": endpoint{},
|
||||
"ap-south-1": endpoint{},
|
||||
"ap-southeast-1": endpoint{},
|
||||
"ap-southeast-2": endpoint{},
|
||||
"ca-central-1": endpoint{},
|
||||
"eu-central-1": endpoint{},
|
||||
"eu-north-1": endpoint{},
|
||||
"eu-west-1": endpoint{},
|
||||
"eu-west-2": endpoint{},
|
||||
"eu-west-3": endpoint{},
|
||||
"sa-east-1": endpoint{},
|
||||
"us-east-1": endpoint{},
|
||||
"us-east-2": endpoint{},
|
||||
"us-west-1": endpoint{},
|
||||
|
|
@ -2169,12 +2193,17 @@ var awsPartition = partition{
|
|||
|
||||
Endpoints: endpoints{
|
||||
"ap-northeast-1": endpoint{},
|
||||
"ap-northeast-2": endpoint{},
|
||||
"ap-south-1": endpoint{},
|
||||
"ap-southeast-1": endpoint{},
|
||||
"ap-southeast-2": endpoint{},
|
||||
"ca-central-1": endpoint{},
|
||||
"eu-central-1": endpoint{},
|
||||
"eu-west-1": endpoint{},
|
||||
"eu-west-2": endpoint{},
|
||||
"us-east-1": endpoint{},
|
||||
"us-east-2": endpoint{},
|
||||
"us-west-1": endpoint{},
|
||||
"us-west-2": endpoint{},
|
||||
},
|
||||
},
|
||||
|
|
@ -2398,7 +2427,8 @@ var awsPartition = partition{
|
|||
"mgh": service{
|
||||
|
||||
Endpoints: endpoints{
|
||||
"us-west-2": endpoint{},
|
||||
"eu-central-1": endpoint{},
|
||||
"us-west-2": endpoint{},
|
||||
},
|
||||
},
|
||||
"mobileanalytics": service{
|
||||
|
|
@ -2803,6 +2833,10 @@ var awsPartition = partition{
|
|||
|
||||
Endpoints: endpoints{
|
||||
"ap-northeast-1": endpoint{},
|
||||
"ap-northeast-2": endpoint{},
|
||||
"ap-southeast-1": endpoint{},
|
||||
"ap-southeast-2": endpoint{},
|
||||
"eu-central-1": endpoint{},
|
||||
"eu-west-1": endpoint{},
|
||||
"us-east-1": endpoint{},
|
||||
"us-east-2": endpoint{},
|
||||
|
|
@ -3053,7 +3087,7 @@ var awsPartition = partition{
|
|||
},
|
||||
},
|
||||
"s3": service{
|
||||
PartitionEndpoint: "us-east-1",
|
||||
PartitionEndpoint: "aws-global",
|
||||
IsRegionalized: boxedTrue,
|
||||
Defaults: endpoint{
|
||||
Protocols: []string{"http", "https"},
|
||||
|
|
@ -3078,6 +3112,12 @@ var awsPartition = partition{
|
|||
Hostname: "s3.ap-southeast-2.amazonaws.com",
|
||||
SignatureVersions: []string{"s3", "s3v4"},
|
||||
},
|
||||
"aws-global": endpoint{
|
||||
Hostname: "s3.amazonaws.com",
|
||||
CredentialScope: credentialScope{
|
||||
Region: "us-east-1",
|
||||
},
|
||||
},
|
||||
"ca-central-1": endpoint{},
|
||||
"eu-central-1": endpoint{},
|
||||
"eu-north-1": endpoint{},
|
||||
|
|
@ -3099,10 +3139,7 @@ var awsPartition = partition{
|
|||
Hostname: "s3.sa-east-1.amazonaws.com",
|
||||
SignatureVersions: []string{"s3", "s3v4"},
|
||||
},
|
||||
"us-east-1": endpoint{
|
||||
Hostname: "s3.amazonaws.com",
|
||||
SignatureVersions: []string{"s3", "s3v4"},
|
||||
},
|
||||
"us-east-1": endpoint{},
|
||||
"us-east-2": endpoint{},
|
||||
"us-west-1": endpoint{
|
||||
Hostname: "s3.us-west-1.amazonaws.com",
|
||||
|
|
@ -3499,6 +3536,10 @@ var awsPartition = partition{
|
|||
|
||||
Endpoints: endpoints{
|
||||
"ap-northeast-1": endpoint{},
|
||||
"ap-northeast-2": endpoint{},
|
||||
"ap-southeast-1": endpoint{},
|
||||
"ap-southeast-2": endpoint{},
|
||||
"eu-central-1": endpoint{},
|
||||
"eu-west-1": endpoint{},
|
||||
"us-east-1": endpoint{},
|
||||
"us-east-2": endpoint{},
|
||||
|
|
@ -4122,11 +4163,7 @@ var awscnPartition = partition{
|
|||
},
|
||||
"application-autoscaling": service{
|
||||
Defaults: endpoint{
|
||||
Hostname: "autoscaling.{region}.amazonaws.com.cn",
|
||||
Protocols: []string{"http", "https"},
|
||||
CredentialScope: credentialScope{
|
||||
Service: "application-autoscaling",
|
||||
},
|
||||
},
|
||||
Endpoints: endpoints{
|
||||
"cn-north-1": endpoint{},
|
||||
|
|
@ -4204,6 +4241,12 @@ var awscnPartition = partition{
|
|||
"cn-northwest-1": endpoint{},
|
||||
},
|
||||
},
|
||||
"dax": service{
|
||||
|
||||
Endpoints: endpoints{
|
||||
"cn-northwest-1": endpoint{},
|
||||
},
|
||||
},
|
||||
"directconnect": service{
|
||||
|
||||
Endpoints: endpoints{
|
||||
|
|
@ -4591,6 +4634,12 @@ var awscnPartition = partition{
|
|||
},
|
||||
},
|
||||
},
|
||||
"workspaces": service{
|
||||
|
||||
Endpoints: endpoints{
|
||||
"cn-northwest-1": endpoint{},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
|
|
@ -4671,7 +4720,8 @@ var awsusgovPartition = partition{
|
|||
},
|
||||
"application-autoscaling": service{
|
||||
Defaults: endpoint{
|
||||
Hostname: "autoscaling.{region}.amazonaws.com",
|
||||
Hostname: "autoscaling.{region}.amazonaws.com",
|
||||
Protocols: []string{"http", "https"},
|
||||
CredentialScope: credentialScope{
|
||||
Service: "application-autoscaling",
|
||||
},
|
||||
|
|
@ -4808,6 +4858,7 @@ var awsusgovPartition = partition{
|
|||
Region: "us-gov-west-1",
|
||||
},
|
||||
},
|
||||
"us-gov-east-1": endpoint{},
|
||||
"us-gov-west-1": endpoint{},
|
||||
},
|
||||
},
|
||||
|
|
@ -5476,11 +5527,8 @@ var awsisoPartition = partition{
|
|||
},
|
||||
"application-autoscaling": service{
|
||||
Defaults: endpoint{
|
||||
Hostname: "autoscaling.{region}.amazonaws.com",
|
||||
Hostname: "autoscaling.us-iso-east-1.c2s.ic.gov",
|
||||
Protocols: []string{"http", "https"},
|
||||
CredentialScope: credentialScope{
|
||||
Service: "application-autoscaling",
|
||||
},
|
||||
},
|
||||
Endpoints: endpoints{
|
||||
"us-iso-east-1": endpoint{},
|
||||
|
|
@ -5808,11 +5856,8 @@ var awsisobPartition = partition{
|
|||
Services: services{
|
||||
"application-autoscaling": service{
|
||||
Defaults: endpoint{
|
||||
Hostname: "autoscaling.{region}.amazonaws.com",
|
||||
Hostname: "autoscaling.us-isob-east-1.sc2s.sgov.gov",
|
||||
Protocols: []string{"http", "https"},
|
||||
CredentialScope: credentialScope{
|
||||
Service: "application-autoscaling",
|
||||
},
|
||||
},
|
||||
Endpoints: endpoints{
|
||||
"us-isob-east-1": endpoint{},
|
||||
|
|
|
|||
|
|
@ -50,12 +50,28 @@ type Options struct {
|
|||
|
||||
// STS Regional Endpoint flag helps with resolving the STS endpoint
|
||||
STSRegionalEndpoint STSRegionalEndpoint
|
||||
|
||||
// S3 Regional Endpoint flag helps with resolving the S3 endpoint
|
||||
S3UsEast1RegionalEndpoint S3UsEast1RegionalEndpoint
|
||||
}
|
||||
|
||||
// STSRegionalEndpoint is an enum type alias for int
|
||||
// It is used internally by the core sdk as STS Regional Endpoint flag value
|
||||
// STSRegionalEndpoint is an enum for the states of the STS Regional Endpoint
|
||||
// options.
|
||||
type STSRegionalEndpoint int
|
||||
|
||||
func (e STSRegionalEndpoint) String() string {
|
||||
switch e {
|
||||
case LegacySTSEndpoint:
|
||||
return "legacy"
|
||||
case RegionalSTSEndpoint:
|
||||
return "regional"
|
||||
case UnsetSTSEndpoint:
|
||||
return ""
|
||||
default:
|
||||
return "unknown"
|
||||
}
|
||||
}
|
||||
|
||||
const (
|
||||
|
||||
// UnsetSTSEndpoint represents that STS Regional Endpoint flag is not specified.
|
||||
|
|
@ -86,6 +102,55 @@ func GetSTSRegionalEndpoint(s string) (STSRegionalEndpoint, error) {
|
|||
}
|
||||
}
|
||||
|
||||
// S3UsEast1RegionalEndpoint is an enum for the states of the S3 us-east-1
|
||||
// Regional Endpoint options.
|
||||
type S3UsEast1RegionalEndpoint int
|
||||
|
||||
func (e S3UsEast1RegionalEndpoint) String() string {
|
||||
switch e {
|
||||
case LegacyS3UsEast1Endpoint:
|
||||
return "legacy"
|
||||
case RegionalS3UsEast1Endpoint:
|
||||
return "regional"
|
||||
case UnsetS3UsEast1Endpoint:
|
||||
return ""
|
||||
default:
|
||||
return "unknown"
|
||||
}
|
||||
}
|
||||
|
||||
const (
|
||||
|
||||
// UnsetS3UsEast1Endpoint represents that S3 Regional Endpoint flag is not
|
||||
// specified.
|
||||
UnsetS3UsEast1Endpoint S3UsEast1RegionalEndpoint = iota
|
||||
|
||||
// LegacyS3UsEast1Endpoint represents when S3 Regional Endpoint flag is
|
||||
// specified to use legacy endpoints.
|
||||
LegacyS3UsEast1Endpoint
|
||||
|
||||
// RegionalS3UsEast1Endpoint represents when S3 Regional Endpoint flag is
|
||||
// specified to use regional endpoints.
|
||||
RegionalS3UsEast1Endpoint
|
||||
)
|
||||
|
||||
// GetS3UsEast1RegionalEndpoint function returns the S3UsEast1RegionalEndpointFlag based
|
||||
// on the input string provided in env config or shared config by the user.
|
||||
//
|
||||
// `legacy`, `regional` are the only case-insensitive valid strings for
|
||||
// resolving the S3 regional Endpoint flag.
|
||||
func GetS3UsEast1RegionalEndpoint(s string) (S3UsEast1RegionalEndpoint, error) {
|
||||
switch {
|
||||
case strings.EqualFold(s, "legacy"):
|
||||
return LegacyS3UsEast1Endpoint, nil
|
||||
case strings.EqualFold(s, "regional"):
|
||||
return RegionalS3UsEast1Endpoint, nil
|
||||
default:
|
||||
return UnsetS3UsEast1Endpoint,
|
||||
fmt.Errorf("unable to resolve the value of S3UsEast1RegionalEndpoint for %v", s)
|
||||
}
|
||||
}
|
||||
|
||||
// Set combines all of the option functions together.
|
||||
func (o *Options) Set(optFns ...func(*Options)) {
|
||||
for _, fn := range optFns {
|
||||
|
|
|
|||
|
|
@ -0,0 +1,24 @@
|
|||
package endpoints
|
||||
|
||||
var legacyGlobalRegions = map[string]map[string]struct{}{
|
||||
"sts": {
|
||||
"ap-northeast-1": {},
|
||||
"ap-south-1": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"ca-central-1": {},
|
||||
"eu-central-1": {},
|
||||
"eu-north-1": {},
|
||||
"eu-west-1": {},
|
||||
"eu-west-2": {},
|
||||
"eu-west-3": {},
|
||||
"sa-east-1": {},
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
},
|
||||
"s3": {
|
||||
"us-east-1": {},
|
||||
},
|
||||
}
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
package endpoints
|
||||
|
||||
var stsLegacyGlobalRegions = map[string]struct{}{
|
||||
"ap-northeast-1": {},
|
||||
"ap-south-1": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"ca-central-1": {},
|
||||
"eu-central-1": {},
|
||||
"eu-north-1": {},
|
||||
"eu-west-1": {},
|
||||
"eu-west-2": {},
|
||||
"eu-west-3": {},
|
||||
"sa-east-1": {},
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
}
|
||||
|
|
@ -110,8 +110,9 @@ func (p partition) EndpointFor(service, region string, opts ...func(*Options)) (
|
|||
region = s.PartitionEndpoint
|
||||
}
|
||||
|
||||
if service == "sts" && opt.STSRegionalEndpoint != RegionalSTSEndpoint {
|
||||
if _, ok := stsLegacyGlobalRegions[region]; ok {
|
||||
if (service == "sts" && opt.STSRegionalEndpoint != RegionalSTSEndpoint) ||
|
||||
(service == "s3" && opt.S3UsEast1RegionalEndpoint != RegionalS3UsEast1Endpoint) {
|
||||
if _, ok := legacyGlobalRegions[service][region]; ok {
|
||||
region = "aws-global"
|
||||
}
|
||||
}
|
||||
|
|
@ -240,20 +241,6 @@ func (e endpoint) resolve(service, partitionID, region, dnsSuffix string, defs [
|
|||
merged.mergeIn(e)
|
||||
e = merged
|
||||
|
||||
hostname := e.Hostname
|
||||
|
||||
// Offset the hostname for dualstack if enabled
|
||||
if opts.UseDualStack && e.HasDualStack == boxedTrue {
|
||||
hostname = e.DualStackHostname
|
||||
}
|
||||
|
||||
u := strings.Replace(hostname, "{service}", service, 1)
|
||||
u = strings.Replace(u, "{region}", region, 1)
|
||||
u = strings.Replace(u, "{dnsSuffix}", dnsSuffix, 1)
|
||||
|
||||
scheme := getEndpointScheme(e.Protocols, opts.DisableSSL)
|
||||
u = fmt.Sprintf("%s://%s", scheme, u)
|
||||
|
||||
signingRegion := e.CredentialScope.Region
|
||||
if len(signingRegion) == 0 {
|
||||
signingRegion = region
|
||||
|
|
@ -266,6 +253,20 @@ func (e endpoint) resolve(service, partitionID, region, dnsSuffix string, defs [
|
|||
signingNameDerived = true
|
||||
}
|
||||
|
||||
hostname := e.Hostname
|
||||
// Offset the hostname for dualstack if enabled
|
||||
if opts.UseDualStack && e.HasDualStack == boxedTrue {
|
||||
hostname = e.DualStackHostname
|
||||
region = signingRegion
|
||||
}
|
||||
|
||||
u := strings.Replace(hostname, "{service}", service, 1)
|
||||
u = strings.Replace(u, "{region}", region, 1)
|
||||
u = strings.Replace(u, "{dnsSuffix}", dnsSuffix, 1)
|
||||
|
||||
scheme := getEndpointScheme(e.Protocols, opts.DisableSSL)
|
||||
u = fmt.Sprintf("%s://%s", scheme, u)
|
||||
|
||||
return ResolvedEndpoint{
|
||||
URL: u,
|
||||
PartitionID: partitionID,
|
||||
|
|
|
|||
|
|
@ -17,11 +17,13 @@ import (
|
|||
// does the pagination between API operations, and Paginator defines the
|
||||
// configuration that will be used per page request.
|
||||
//
|
||||
// cont := true
|
||||
// for p.Next() && cont {
|
||||
// for p.Next() {
|
||||
// data := p.Page().(*s3.ListObjectsOutput)
|
||||
// // process the page's data
|
||||
// // ...
|
||||
// // break out of loop to stop fetching additional pages
|
||||
// }
|
||||
//
|
||||
// return p.Err()
|
||||
//
|
||||
// See service client API operation Pages methods for examples how the SDK will
|
||||
|
|
|
|||
|
|
@ -47,10 +47,10 @@ func resolveCredentials(cfg *aws.Config,
|
|||
}
|
||||
|
||||
// WebIdentityEmptyRoleARNErr will occur if 'AWS_WEB_IDENTITY_TOKEN_FILE' was set but
|
||||
// 'AWS_IAM_ROLE_ARN' was not set.
|
||||
// 'AWS_ROLE_ARN' was not set.
|
||||
var WebIdentityEmptyRoleARNErr = awserr.New(stscreds.ErrCodeWebIdentity, "role ARN is not set", nil)
|
||||
|
||||
// WebIdentityEmptyTokenFilePathErr will occur if 'AWS_IAM_ROLE_ARN' was set but
|
||||
// WebIdentityEmptyTokenFilePathErr will occur if 'AWS_ROLE_ARN' was set but
|
||||
// 'AWS_WEB_IDENTITY_TOKEN_FILE' was not set.
|
||||
var WebIdentityEmptyTokenFilePathErr = awserr.New(stscreds.ErrCodeWebIdentity, "token file path is not set", nil)
|
||||
|
||||
|
|
|
|||
|
|
@ -128,11 +128,19 @@ type envConfig struct {
|
|||
// AWS_ROLE_SESSION_NAME=session_name
|
||||
RoleSessionName string
|
||||
|
||||
// Specifies the Regional Endpoint flag for the sdk to resolve the endpoint for a service
|
||||
// Specifies the STS Regional Endpoint flag for the SDK to resolve the endpoint
|
||||
// for a service.
|
||||
//
|
||||
// AWS_STS_REGIONAL_ENDPOINTS =sts_regional_endpoint
|
||||
// AWS_STS_REGIONAL_ENDPOINTS=regional
|
||||
// This can take value as `regional` or `legacy`
|
||||
STSRegionalEndpoint endpoints.STSRegionalEndpoint
|
||||
|
||||
// Specifies the S3 Regional Endpoint flag for the SDK to resolve the
|
||||
// endpoint for a service.
|
||||
//
|
||||
// AWS_S3_US_EAST_1_REGIONAL_ENDPOINT=regional
|
||||
// This can take value as `regional` or `legacy`
|
||||
S3UsEast1RegionalEndpoint endpoints.S3UsEast1RegionalEndpoint
|
||||
}
|
||||
|
||||
var (
|
||||
|
|
@ -190,6 +198,9 @@ var (
|
|||
stsRegionalEndpointKey = []string{
|
||||
"AWS_STS_REGIONAL_ENDPOINTS",
|
||||
}
|
||||
s3UsEast1RegionalEndpoint = []string{
|
||||
"AWS_S3_US_EAST_1_REGIONAL_ENDPOINT",
|
||||
}
|
||||
)
|
||||
|
||||
// loadEnvConfig retrieves the SDK's environment configuration.
|
||||
|
|
@ -275,14 +286,24 @@ func envConfigLoad(enableSharedConfig bool) (envConfig, error) {
|
|||
|
||||
cfg.CustomCABundle = os.Getenv("AWS_CA_BUNDLE")
|
||||
|
||||
var err error
|
||||
// STS Regional Endpoint variable
|
||||
for _, k := range stsRegionalEndpointKey {
|
||||
if v := os.Getenv(k); len(v) != 0 {
|
||||
STSRegionalEndpoint, err := endpoints.GetSTSRegionalEndpoint(v)
|
||||
cfg.STSRegionalEndpoint, err = endpoints.GetSTSRegionalEndpoint(v)
|
||||
if err != nil {
|
||||
return cfg, fmt.Errorf("failed to load, %v from env config, %v", k, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// S3 Regional Endpoint variable
|
||||
for _, k := range s3UsEast1RegionalEndpoint {
|
||||
if v := os.Getenv(k); len(v) != 0 {
|
||||
cfg.S3UsEast1RegionalEndpoint, err = endpoints.GetS3UsEast1RegionalEndpoint(v)
|
||||
if err != nil {
|
||||
return cfg, fmt.Errorf("failed to load, %v from env config, %v", k, err)
|
||||
}
|
||||
cfg.STSRegionalEndpoint = STSRegionalEndpoint
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -555,7 +555,20 @@ func mergeConfigSrcs(cfg, userCfg *aws.Config,
|
|||
}
|
||||
|
||||
// Regional Endpoint flag for STS endpoint resolving
|
||||
mergeSTSRegionalEndpointConfig(cfg, envCfg, sharedCfg)
|
||||
mergeSTSRegionalEndpointConfig(cfg, []endpoints.STSRegionalEndpoint{
|
||||
userCfg.STSRegionalEndpoint,
|
||||
envCfg.STSRegionalEndpoint,
|
||||
sharedCfg.STSRegionalEndpoint,
|
||||
endpoints.LegacySTSEndpoint,
|
||||
})
|
||||
|
||||
// Regional Endpoint flag for S3 endpoint resolving
|
||||
mergeS3UsEast1RegionalEndpointConfig(cfg, []endpoints.S3UsEast1RegionalEndpoint{
|
||||
userCfg.S3UsEast1RegionalEndpoint,
|
||||
envCfg.S3UsEast1RegionalEndpoint,
|
||||
sharedCfg.S3UsEast1RegionalEndpoint,
|
||||
endpoints.LegacyS3UsEast1Endpoint,
|
||||
})
|
||||
|
||||
// Configure credentials if not already set by the user when creating the
|
||||
// Session.
|
||||
|
|
@ -570,20 +583,22 @@ func mergeConfigSrcs(cfg, userCfg *aws.Config,
|
|||
return nil
|
||||
}
|
||||
|
||||
// mergeSTSRegionalEndpointConfig function merges the STSRegionalEndpoint into cfg from
|
||||
// envConfig and SharedConfig with envConfig being given precedence over SharedConfig
|
||||
func mergeSTSRegionalEndpointConfig(cfg *aws.Config, envCfg envConfig, sharedCfg sharedConfig) error {
|
||||
|
||||
cfg.STSRegionalEndpoint = envCfg.STSRegionalEndpoint
|
||||
|
||||
if cfg.STSRegionalEndpoint == endpoints.UnsetSTSEndpoint {
|
||||
cfg.STSRegionalEndpoint = sharedCfg.STSRegionalEndpoint
|
||||
func mergeSTSRegionalEndpointConfig(cfg *aws.Config, values []endpoints.STSRegionalEndpoint) {
|
||||
for _, v := range values {
|
||||
if v != endpoints.UnsetSTSEndpoint {
|
||||
cfg.STSRegionalEndpoint = v
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if cfg.STSRegionalEndpoint == endpoints.UnsetSTSEndpoint {
|
||||
cfg.STSRegionalEndpoint = endpoints.LegacySTSEndpoint
|
||||
func mergeS3UsEast1RegionalEndpointConfig(cfg *aws.Config, values []endpoints.S3UsEast1RegionalEndpoint) {
|
||||
for _, v := range values {
|
||||
if v != endpoints.UnsetS3UsEast1Endpoint {
|
||||
cfg.S3UsEast1RegionalEndpoint = v
|
||||
break
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func initHandlers(s *Session) {
|
||||
|
|
@ -653,6 +668,11 @@ func (s *Session) resolveEndpoint(service, region string, cfg *aws.Config) (endp
|
|||
// precedence.
|
||||
opt.STSRegionalEndpoint = cfg.STSRegionalEndpoint
|
||||
|
||||
// Support for S3UsEast1RegionalEndpoint where the S3UsEast1RegionalEndpoint is
|
||||
// provided in envConfig or sharedConfig with envConfig getting
|
||||
// precedence.
|
||||
opt.S3UsEast1RegionalEndpoint = cfg.S3UsEast1RegionalEndpoint
|
||||
|
||||
// Support the condition where the service is modeled but its
|
||||
// endpoint metadata is not available.
|
||||
opt.ResolveUnknownService = true
|
||||
|
|
|
|||
|
|
@ -44,6 +44,9 @@ const (
|
|||
// Additional config fields for regional or legacy endpoints
|
||||
stsRegionalEndpointSharedKey = `sts_regional_endpoints`
|
||||
|
||||
// Additional config fields for regional or legacy endpoints
|
||||
s3UsEast1RegionalSharedKey = `s3_us_east_1_regional_endpoint`
|
||||
|
||||
// DefaultSharedConfigProfile is the default profile to be used when
|
||||
// loading configuration from the config files if another profile name
|
||||
// is not provided.
|
||||
|
|
@ -92,11 +95,17 @@ type sharedConfig struct {
|
|||
CSMPort string
|
||||
CSMClientID string
|
||||
|
||||
// Specifies the Regional Endpoint flag for the sdk to resolve the endpoint for a service
|
||||
// Specifies the Regional Endpoint flag for the SDK to resolve the endpoint for a service
|
||||
//
|
||||
// sts_regional_endpoints = sts_regional_endpoint
|
||||
// sts_regional_endpoints = regional
|
||||
// This can take value as `LegacySTSEndpoint` or `RegionalSTSEndpoint`
|
||||
STSRegionalEndpoint endpoints.STSRegionalEndpoint
|
||||
|
||||
// Specifies the Regional Endpoint flag for the SDK to resolve the endpoint for a service
|
||||
//
|
||||
// s3_us_east_1_regional_endpoint = regional
|
||||
// This can take value as `LegacyS3UsEast1Endpoint` or `RegionalS3UsEast1Endpoint`
|
||||
S3UsEast1RegionalEndpoint endpoints.S3UsEast1RegionalEndpoint
|
||||
}
|
||||
|
||||
type sharedConfigFile struct {
|
||||
|
|
@ -259,10 +268,19 @@ func (cfg *sharedConfig) setFromIniFile(profile string, file sharedConfigFile, e
|
|||
sre, err := endpoints.GetSTSRegionalEndpoint(v)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to load %s from shared config, %s, %v",
|
||||
stsRegionalEndpointKey, file.Filename, err)
|
||||
stsRegionalEndpointSharedKey, file.Filename, err)
|
||||
}
|
||||
cfg.STSRegionalEndpoint = sre
|
||||
}
|
||||
|
||||
if v := section.String(s3UsEast1RegionalSharedKey); len(v) != 0 {
|
||||
sre, err := endpoints.GetS3UsEast1RegionalEndpoint(v)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to load %s from shared config, %s, %v",
|
||||
s3UsEast1RegionalSharedKey, file.Filename, err)
|
||||
}
|
||||
cfg.S3UsEast1RegionalEndpoint = sre
|
||||
}
|
||||
}
|
||||
|
||||
updateString(&cfg.CredentialProcess, section, credentialProcessKey)
|
||||
|
|
|
|||
|
|
@ -5,4 +5,4 @@ package aws
|
|||
const SDKName = "aws-sdk-go"
|
||||
|
||||
// SDKVersion is the version of this SDK
|
||||
const SDKVersion = "1.25.32"
|
||||
const SDKVersion = "1.25.41"
|
||||
|
|
|
|||
|
|
@ -1378,10 +1378,12 @@ func (c *ACMPCA) ListCertificateAuthoritiesPagesWithContext(ctx aws.Context, inp
|
|||
},
|
||||
}
|
||||
|
||||
cont := true
|
||||
for p.Next() && cont {
|
||||
cont = fn(p.Page().(*ListCertificateAuthoritiesOutput), !p.HasNextPage())
|
||||
for p.Next() {
|
||||
if !fn(p.Page().(*ListCertificateAuthoritiesOutput), !p.HasNextPage()) {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
return p.Err()
|
||||
}
|
||||
|
||||
|
|
@ -1530,10 +1532,12 @@ func (c *ACMPCA) ListPermissionsPagesWithContext(ctx aws.Context, input *ListPer
|
|||
},
|
||||
}
|
||||
|
||||
cont := true
|
||||
for p.Next() && cont {
|
||||
cont = fn(p.Page().(*ListPermissionsOutput), !p.HasNextPage())
|
||||
for p.Next() {
|
||||
if !fn(p.Page().(*ListPermissionsOutput), !p.HasNextPage()) {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
return p.Err()
|
||||
}
|
||||
|
||||
|
|
@ -1677,10 +1681,12 @@ func (c *ACMPCA) ListTagsPagesWithContext(ctx aws.Context, input *ListTagsInput,
|
|||
},
|
||||
}
|
||||
|
||||
cont := true
|
||||
for p.Next() && cont {
|
||||
cont = fn(p.Page().(*ListTagsOutput), !p.HasNextPage())
|
||||
for p.Next() {
|
||||
if !fn(p.Page().(*ListTagsOutput), !p.HasNextPage()) {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
return p.Err()
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -39,6 +39,8 @@ const (
|
|||
// aws.Config parameter to add your extra config.
|
||||
//
|
||||
// Example:
|
||||
// mySession := session.Must(session.NewSession())
|
||||
//
|
||||
// // Create a ACMPCA client from just a session.
|
||||
// svc := acmpca.New(mySession)
|
||||
//
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -39,6 +39,8 @@ const (
|
|||
// aws.Config parameter to add your extra config.
|
||||
//
|
||||
// Example:
|
||||
// mySession := session.Must(session.NewSession())
|
||||
//
|
||||
// // Create a EC2 client from just a session.
|
||||
// svc := ec2.New(mySession)
|
||||
//
|
||||
|
|
|
|||
|
|
@ -952,6 +952,57 @@ func (c *EC2) WaitUntilPasswordDataAvailableWithContext(ctx aws.Context, input *
|
|||
return w.WaitWithContext(ctx)
|
||||
}
|
||||
|
||||
// WaitUntilSecurityGroupExists uses the Amazon EC2 API operation
|
||||
// DescribeSecurityGroups to wait for a condition to be met before returning.
|
||||
// If the condition is not met within the max attempt window, an error will
|
||||
// be returned.
|
||||
func (c *EC2) WaitUntilSecurityGroupExists(input *DescribeSecurityGroupsInput) error {
|
||||
return c.WaitUntilSecurityGroupExistsWithContext(aws.BackgroundContext(), input)
|
||||
}
|
||||
|
||||
// WaitUntilSecurityGroupExistsWithContext is an extended version of WaitUntilSecurityGroupExists.
|
||||
// With the support for passing in a context and options to configure the
|
||||
// Waiter and the underlying request options.
|
||||
//
|
||||
// The context must be non-nil and will be used for request cancellation. If
|
||||
// the context is nil a panic will occur. In the future the SDK may create
|
||||
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
|
||||
// for more information on using Contexts.
|
||||
func (c *EC2) WaitUntilSecurityGroupExistsWithContext(ctx aws.Context, input *DescribeSecurityGroupsInput, opts ...request.WaiterOption) error {
|
||||
w := request.Waiter{
|
||||
Name: "WaitUntilSecurityGroupExists",
|
||||
MaxAttempts: 6,
|
||||
Delay: request.ConstantWaiterDelay(5 * time.Second),
|
||||
Acceptors: []request.WaiterAcceptor{
|
||||
{
|
||||
State: request.SuccessWaiterState,
|
||||
Matcher: request.PathWaiterMatch, Argument: "length(SecurityGroups[].GroupId) > `0`",
|
||||
Expected: true,
|
||||
},
|
||||
{
|
||||
State: request.RetryWaiterState,
|
||||
Matcher: request.ErrorWaiterMatch,
|
||||
Expected: "InvalidGroupNotFound",
|
||||
},
|
||||
},
|
||||
Logger: c.Config.Logger,
|
||||
NewRequest: func(opts []request.Option) (*request.Request, error) {
|
||||
var inCpy *DescribeSecurityGroupsInput
|
||||
if input != nil {
|
||||
tmp := *input
|
||||
inCpy = &tmp
|
||||
}
|
||||
req, _ := c.DescribeSecurityGroupsRequest(inCpy)
|
||||
req.SetContext(ctx)
|
||||
req.ApplyOptions(opts...)
|
||||
return req, nil
|
||||
},
|
||||
}
|
||||
w.ApplyOptions(opts...)
|
||||
|
||||
return w.WaitWithContext(ctx)
|
||||
}
|
||||
|
||||
// WaitUntilSnapshotCompleted uses the Amazon EC2 API operation
|
||||
// DescribeSnapshots to wait for a condition to be met before returning.
|
||||
// If the condition is not met within the max attempt window, an error will
|
||||
|
|
|
|||
|
|
@ -78,6 +78,8 @@ func (c *STS) AssumeRoleRequest(input *AssumeRoleInput) (req *request.Request, o
|
|||
// IAM Roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Session Duration
|
||||
//
|
||||
// By default, the temporary security credentials created by AssumeRole last
|
||||
// for one hour. However, you can use the optional DurationSeconds parameter
|
||||
// to specify the duration of your session. You can provide a value from 900
|
||||
|
|
@ -91,6 +93,8 @@ func (c *STS) AssumeRoleRequest(input *AssumeRoleInput) (req *request.Request, o
|
|||
// URL. For more information, see Using IAM Roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Permissions
|
||||
//
|
||||
// The temporary security credentials created by AssumeRole can be used to make
|
||||
// API calls to any AWS service with the following exception: You cannot call
|
||||
// the AWS STS GetFederationToken or GetSessionToken API operations.
|
||||
|
|
@ -99,7 +103,7 @@ func (c *STS) AssumeRoleRequest(input *AssumeRoleInput) (req *request.Request, o
|
|||
// to this operation. You can pass a single JSON policy document to use as an
|
||||
// inline session policy. You can also specify up to 10 managed policies to
|
||||
// use as managed session policies. The plain text that you use for both inline
|
||||
// and managed session policies shouldn't exceed 2048 characters. Passing policies
|
||||
// and managed session policies can't exceed 2,048 characters. Passing policies
|
||||
// to this operation returns new temporary credentials. The resulting session's
|
||||
// permissions are the intersection of the role's identity-based policy and
|
||||
// the session policies. You can use the role's temporary credentials in subsequent
|
||||
|
|
@ -131,6 +135,24 @@ func (c *STS) AssumeRoleRequest(input *AssumeRoleInput) (req *request.Request, o
|
|||
// see IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Tags
|
||||
//
|
||||
// (Optional) You can pass tag key-value pairs to your session. These tags are
|
||||
// called session tags. For more information about session tags, see Passing
|
||||
// Session Tags in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// An administrator must grant you the permissions necessary to pass session
|
||||
// tags. The administrator can also create granular permissions to allow you
|
||||
// to pass only specific session tags. For more information, see Tutorial: Using
|
||||
// Tags for Attribute-Based Access Control (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// You can set the session tags as transitive. Transitive tags persist during
|
||||
// role chaining. For more information, see Chaining Roles with Session Tags
|
||||
// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Using MFA with AssumeRole
|
||||
//
|
||||
// (Optional) You can include multi-factor authentication (MFA) information
|
||||
|
|
@ -165,9 +187,18 @@ func (c *STS) AssumeRoleRequest(input *AssumeRoleInput) (req *request.Request, o
|
|||
// message describes the specific error.
|
||||
//
|
||||
// * ErrCodePackedPolicyTooLargeException "PackedPolicyTooLarge"
|
||||
// The request was rejected because the policy document was too large. The error
|
||||
// message describes how big the policy document is, in packed form, as a percentage
|
||||
// of what the API allows.
|
||||
// The request was rejected because the total packed size of the session policies
|
||||
// and session tags combined was too large. An AWS conversion compresses the
|
||||
// session policy document, session policy ARNs, and session tags into a packed
|
||||
// binary format that has a separate limit. The error message indicates by percentage
|
||||
// how close the policies and tags are to the upper size limit. For more information,
|
||||
// see Passing Session Tags in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// You could receive this error even though you meet other defined session policy
|
||||
// and session tag limits. For more information, see IAM and STS Entity Character
|
||||
// Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// * ErrCodeRegionDisabledException "RegionDisabledException"
|
||||
// STS is not activated in the requested region for the account that is being
|
||||
|
|
@ -256,6 +287,8 @@ func (c *STS) AssumeRoleWithSAMLRequest(input *AssumeRoleWithSAMLInput) (req *re
|
|||
// an access key ID, a secret access key, and a security token. Applications
|
||||
// can use these temporary security credentials to sign calls to AWS services.
|
||||
//
|
||||
// Session Duration
|
||||
//
|
||||
// By default, the temporary security credentials created by AssumeRoleWithSAML
|
||||
// last for one hour. However, you can use the optional DurationSeconds parameter
|
||||
// to specify the duration of your session. Your role session lasts for the
|
||||
|
|
@ -271,6 +304,8 @@ func (c *STS) AssumeRoleWithSAMLRequest(input *AssumeRoleWithSAMLInput) (req *re
|
|||
// URL. For more information, see Using IAM Roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Permissions
|
||||
//
|
||||
// The temporary security credentials created by AssumeRoleWithSAML can be used
|
||||
// to make API calls to any AWS service with the following exception: you cannot
|
||||
// call the STS GetFederationToken or GetSessionToken API operations.
|
||||
|
|
@ -279,7 +314,7 @@ func (c *STS) AssumeRoleWithSAMLRequest(input *AssumeRoleWithSAMLInput) (req *re
|
|||
// to this operation. You can pass a single JSON policy document to use as an
|
||||
// inline session policy. You can also specify up to 10 managed policies to
|
||||
// use as managed session policies. The plain text that you use for both inline
|
||||
// and managed session policies shouldn't exceed 2048 characters. Passing policies
|
||||
// and managed session policies can't exceed 2,048 characters. Passing policies
|
||||
// to this operation returns new temporary credentials. The resulting session's
|
||||
// permissions are the intersection of the role's identity-based policy and
|
||||
// the session policies. You can use the role's temporary credentials in subsequent
|
||||
|
|
@ -289,12 +324,6 @@ func (c *STS) AssumeRoleWithSAMLRequest(input *AssumeRoleWithSAMLInput) (req *re
|
|||
// information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Before your application can call AssumeRoleWithSAML, you must configure your
|
||||
// SAML identity provider (IdP) to issue the claims required by AWS. Additionally,
|
||||
// you must use AWS Identity and Access Management (IAM) to create a SAML provider
|
||||
// entity in your AWS account that represents your identity provider. You must
|
||||
// also create an IAM role that specifies this SAML provider in its trust policy.
|
||||
//
|
||||
// Calling AssumeRoleWithSAML does not require the use of AWS security credentials.
|
||||
// The identity of the caller is validated by using keys in the metadata document
|
||||
// that is uploaded for the SAML provider entity for your identity provider.
|
||||
|
|
@ -302,8 +331,50 @@ func (c *STS) AssumeRoleWithSAMLRequest(input *AssumeRoleWithSAMLInput) (req *re
|
|||
// Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail
|
||||
// logs. The entry includes the value in the NameID element of the SAML assertion.
|
||||
// We recommend that you use a NameIDType that is not associated with any personally
|
||||
// identifiable information (PII). For example, you could instead use the Persistent
|
||||
// Identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).
|
||||
// identifiable information (PII). For example, you could instead use the persistent
|
||||
// identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).
|
||||
//
|
||||
// Tags
|
||||
//
|
||||
// (Optional) You can configure your IdP to pass attributes into your SAML assertion
|
||||
// as session tags. Each session tag consists of a key name and an associated
|
||||
// value. For more information about session tags, see Passing Session Tags
|
||||
// in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// You can pass up to 50 session tags. The plain text session tag keys can’t
|
||||
// exceed 128 characters and the values can’t exceed 256 characters. For these
|
||||
// and additional limits, see IAM and STS Character Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// An AWS conversion compresses the passed session policies and session tags
|
||||
// into a packed binary format that has a separate limit. Your request can fail
|
||||
// for this limit even if your plain text meets the other requirements. The
|
||||
// PackedPolicySize response element indicates by percentage how close the policies
|
||||
// and tags for your request are to the upper size limit.
|
||||
//
|
||||
// You can pass a session tag with the same key as a tag that is attached to
|
||||
// the role. When you do, session tags override the role's tags with the same
|
||||
// key.
|
||||
//
|
||||
// An administrator must grant you the permissions necessary to pass session
|
||||
// tags. The administrator can also create granular permissions to allow you
|
||||
// to pass only specific session tags. For more information, see Tutorial: Using
|
||||
// Tags for Attribute-Based Access Control (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// You can set the session tags as transitive. Transitive tags persist during
|
||||
// role chaining. For more information, see Chaining Roles with Session Tags
|
||||
// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// SAML Configuration
|
||||
//
|
||||
// Before your application can call AssumeRoleWithSAML, you must configure your
|
||||
// SAML identity provider (IdP) to issue the claims required by AWS. Additionally,
|
||||
// you must use AWS Identity and Access Management (IAM) to create a SAML provider
|
||||
// entity in your AWS account that represents your identity provider. You must
|
||||
// also create an IAM role that specifies this SAML provider in its trust policy.
|
||||
//
|
||||
// For more information, see the following resources:
|
||||
//
|
||||
|
|
@ -332,9 +403,18 @@ func (c *STS) AssumeRoleWithSAMLRequest(input *AssumeRoleWithSAMLInput) (req *re
|
|||
// message describes the specific error.
|
||||
//
|
||||
// * ErrCodePackedPolicyTooLargeException "PackedPolicyTooLarge"
|
||||
// The request was rejected because the policy document was too large. The error
|
||||
// message describes how big the policy document is, in packed form, as a percentage
|
||||
// of what the API allows.
|
||||
// The request was rejected because the total packed size of the session policies
|
||||
// and session tags combined was too large. An AWS conversion compresses the
|
||||
// session policy document, session policy ARNs, and session tags into a packed
|
||||
// binary format that has a separate limit. The error message indicates by percentage
|
||||
// how close the policies and tags are to the upper size limit. For more information,
|
||||
// see Passing Session Tags in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// You could receive this error even though you meet other defined session policy
|
||||
// and session tag limits. For more information, see IAM and STS Entity Character
|
||||
// Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// * ErrCodeIDPRejectedClaimException "IDPRejectedClaim"
|
||||
// The identity provider (IdP) reported that authentication failed. This might
|
||||
|
|
@ -456,6 +536,8 @@ func (c *STS) AssumeRoleWithWebIdentityRequest(input *AssumeRoleWithWebIdentityI
|
|||
// key ID, a secret access key, and a security token. Applications can use these
|
||||
// temporary security credentials to sign calls to AWS service API operations.
|
||||
//
|
||||
// Session Duration
|
||||
//
|
||||
// By default, the temporary security credentials created by AssumeRoleWithWebIdentity
|
||||
// last for one hour. However, you can use the optional DurationSeconds parameter
|
||||
// to specify the duration of your session. You can provide a value from 900
|
||||
|
|
@ -469,6 +551,8 @@ func (c *STS) AssumeRoleWithWebIdentityRequest(input *AssumeRoleWithWebIdentityI
|
|||
// URL. For more information, see Using IAM Roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Permissions
|
||||
//
|
||||
// The temporary security credentials created by AssumeRoleWithWebIdentity can
|
||||
// be used to make API calls to any AWS service with the following exception:
|
||||
// you cannot call the STS GetFederationToken or GetSessionToken API operations.
|
||||
|
|
@ -477,7 +561,7 @@ func (c *STS) AssumeRoleWithWebIdentityRequest(input *AssumeRoleWithWebIdentityI
|
|||
// to this operation. You can pass a single JSON policy document to use as an
|
||||
// inline session policy. You can also specify up to 10 managed policies to
|
||||
// use as managed session policies. The plain text that you use for both inline
|
||||
// and managed session policies shouldn't exceed 2048 characters. Passing policies
|
||||
// and managed session policies can't exceed 2,048 characters. Passing policies
|
||||
// to this operation returns new temporary credentials. The resulting session's
|
||||
// permissions are the intersection of the role's identity-based policy and
|
||||
// the session policies. You can use the role's temporary credentials in subsequent
|
||||
|
|
@ -487,6 +571,42 @@ func (c *STS) AssumeRoleWithWebIdentityRequest(input *AssumeRoleWithWebIdentityI
|
|||
// information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Tags
|
||||
//
|
||||
// (Optional) You can configure your IdP to pass attributes into your web identity
|
||||
// token as session tags. Each session tag consists of a key name and an associated
|
||||
// value. For more information about session tags, see Passing Session Tags
|
||||
// in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// You can pass up to 50 session tags. The plain text session tag keys can’t
|
||||
// exceed 128 characters and the values can’t exceed 256 characters. For these
|
||||
// and additional limits, see IAM and STS Character Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// An AWS conversion compresses the passed session policies and session tags
|
||||
// into a packed binary format that has a separate limit. Your request can fail
|
||||
// for this limit even if your plain text meets the other requirements. The
|
||||
// PackedPolicySize response element indicates by percentage how close the policies
|
||||
// and tags for your request are to the upper size limit.
|
||||
//
|
||||
// You can pass a session tag with the same key as a tag that is attached to
|
||||
// the role. When you do, the session tag overrides the role tag with the same
|
||||
// key.
|
||||
//
|
||||
// An administrator must grant you the permissions necessary to pass session
|
||||
// tags. The administrator can also create granular permissions to allow you
|
||||
// to pass only specific session tags. For more information, see Tutorial: Using
|
||||
// Tags for Attribute-Based Access Control (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// You can set the session tags as transitive. Transitive tags persist during
|
||||
// role chaining. For more information, see Chaining Roles with Session Tags
|
||||
// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Identities
|
||||
//
|
||||
// Before your application can call AssumeRoleWithWebIdentity, you must have
|
||||
// an identity token from a supported identity provider and create a role that
|
||||
// the application can assume. The role that your application assumes must trust
|
||||
|
|
@ -514,8 +634,8 @@ func (c *STS) AssumeRoleWithWebIdentityRequest(input *AssumeRoleWithWebIdentityI
|
|||
// * AWS SDK for iOS Developer Guide (http://aws.amazon.com/sdkforios/) and
|
||||
// AWS SDK for Android Developer Guide (http://aws.amazon.com/sdkforandroid/).
|
||||
// These toolkits contain sample apps that show how to invoke the identity
|
||||
// providers, and then how to use the information from these providers to
|
||||
// get and use temporary security credentials.
|
||||
// providers. The toolkits then show how to use the information from these
|
||||
// providers to get and use temporary security credentials.
|
||||
//
|
||||
// * Web Identity Federation with Mobile Applications (http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications).
|
||||
// This article discusses web identity federation and shows an example of
|
||||
|
|
@ -535,9 +655,18 @@ func (c *STS) AssumeRoleWithWebIdentityRequest(input *AssumeRoleWithWebIdentityI
|
|||
// message describes the specific error.
|
||||
//
|
||||
// * ErrCodePackedPolicyTooLargeException "PackedPolicyTooLarge"
|
||||
// The request was rejected because the policy document was too large. The error
|
||||
// message describes how big the policy document is, in packed form, as a percentage
|
||||
// of what the API allows.
|
||||
// The request was rejected because the total packed size of the session policies
|
||||
// and session tags combined was too large. An AWS conversion compresses the
|
||||
// session policy document, session policy ARNs, and session tags into a packed
|
||||
// binary format that has a separate limit. The error message indicates by percentage
|
||||
// how close the policies and tags are to the upper size limit. For more information,
|
||||
// see Passing Session Tags in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// You could receive this error even though you meet other defined session policy
|
||||
// and session tag limits. For more information, see IAM and STS Entity Character
|
||||
// Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// * ErrCodeIDPRejectedClaimException "IDPRejectedClaim"
|
||||
// The identity provider (IdP) reported that authentication failed. This might
|
||||
|
|
@ -547,11 +676,11 @@ func (c *STS) AssumeRoleWithWebIdentityRequest(input *AssumeRoleWithWebIdentityI
|
|||
// can also mean that the claim has expired or has been explicitly revoked.
|
||||
//
|
||||
// * ErrCodeIDPCommunicationErrorException "IDPCommunicationError"
|
||||
// The request could not be fulfilled because the non-AWS identity provider
|
||||
// (IDP) that was asked to verify the incoming identity token could not be reached.
|
||||
// This is often a transient error caused by network conditions. Retry the request
|
||||
// The request could not be fulfilled because the identity provider (IDP) that
|
||||
// was asked to verify the incoming identity token could not be reached. This
|
||||
// is often a transient error caused by network conditions. Retry the request
|
||||
// a limited number of times so that you don't exceed the request rate. If the
|
||||
// error persists, the non-AWS identity provider might be down or not responding.
|
||||
// error persists, the identity provider might be down or not responding.
|
||||
//
|
||||
// * ErrCodeInvalidIdentityTokenException "InvalidIdentityToken"
|
||||
// The web identity token that was passed could not be validated by AWS. Get
|
||||
|
|
@ -676,9 +805,9 @@ func (c *STS) DecodeAuthorizationMessageRequest(input *DecodeAuthorizationMessag
|
|||
//
|
||||
// Returned Error Codes:
|
||||
// * ErrCodeInvalidAuthorizationMessageException "InvalidAuthorizationMessageException"
|
||||
// This error is returned if the message passed to DecodeAuthorizationMessage
|
||||
// was invalid. This can happen if the token contains invalid characters, such
|
||||
// as linebreaks.
|
||||
// The error returned if the message passed to DecodeAuthorizationMessage was
|
||||
// invalid. This can happen if the token contains invalid characters, such as
|
||||
// linebreaks.
|
||||
//
|
||||
// See also, https://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/DecodeAuthorizationMessage
|
||||
func (c *STS) DecodeAuthorizationMessage(input *DecodeAuthorizationMessageInput) (*DecodeAuthorizationMessageOutput, error) {
|
||||
|
|
@ -763,7 +892,8 @@ func (c *STS) GetAccessKeyInfoRequest(input *GetAccessKeyInfoInput) (req *reques
|
|||
// pull a credentials report (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html)
|
||||
// to learn which IAM user owns the keys. To learn who requested the temporary
|
||||
// credentials for an ASIA access key, view the STS events in your CloudTrail
|
||||
// logs (https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html).
|
||||
// logs (https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// This operation does not indicate the state of the access key. The key might
|
||||
// be active, inactive, or deleted. Active keys might not have permissions to
|
||||
|
|
@ -850,7 +980,8 @@ func (c *STS) GetCallerIdentityRequest(input *GetCallerIdentityInput) (req *requ
|
|||
// sts:GetCallerIdentity action, you can still perform this operation. Permissions
|
||||
// are not required because the same information is returned when an IAM user
|
||||
// or role is denied access. To view an example response, see I Am Not Authorized
|
||||
// to Perform: iam:DeleteVirtualMFADevice (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_access-denied-delete-mfa).
|
||||
// to Perform: iam:DeleteVirtualMFADevice (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_access-denied-delete-mfa)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
|
||||
// with awserr.Error's Code and Message methods to get detailed information about
|
||||
|
|
@ -942,7 +1073,8 @@ func (c *STS) GetFederationTokenRequest(input *GetFederationTokenInput) (req *re
|
|||
// or an OpenID Connect-compatible identity provider. In this case, we recommend
|
||||
// that you use Amazon Cognito (http://aws.amazon.com/cognito/) or AssumeRoleWithWebIdentity.
|
||||
// For more information, see Federation Through a Web-based Identity Provider
|
||||
// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity).
|
||||
// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// You can also call GetFederationToken using the security credentials of an
|
||||
// AWS account root user, but we do not recommend it. Instead, we recommend
|
||||
|
|
@ -952,41 +1084,67 @@ func (c *STS) GetFederationTokenRequest(input *GetFederationTokenInput) (req *re
|
|||
// Practices (https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Session duration
|
||||
//
|
||||
// The temporary credentials are valid for the specified duration, from 900
|
||||
// seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default
|
||||
// is 43,200 seconds (12 hours). Temporary credentials that are obtained by
|
||||
// using AWS account root user credentials have a maximum duration of 3,600
|
||||
// seconds (1 hour).
|
||||
//
|
||||
// The temporary security credentials created by GetFederationToken can be used
|
||||
// to make API calls to any AWS service with the following exceptions:
|
||||
//
|
||||
// * You cannot use these credentials to call any IAM API operations.
|
||||
//
|
||||
// * You cannot call any STS API operations except GetCallerIdentity.
|
||||
// session duration is 43,200 seconds (12 hours). Temporary credentials that
|
||||
// are obtained by using AWS account root user credentials have a maximum duration
|
||||
// of 3,600 seconds (1 hour).
|
||||
//
|
||||
// Permissions
|
||||
//
|
||||
// You can use the temporary credentials created by GetFederationToken in any
|
||||
// AWS service except the following:
|
||||
//
|
||||
// * You cannot call any IAM operations using the AWS CLI or the AWS API.
|
||||
//
|
||||
// * You cannot call any STS operations except GetCallerIdentity.
|
||||
//
|
||||
// You must pass an inline or managed session policy (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session)
|
||||
// to this operation. You can pass a single JSON policy document to use as an
|
||||
// inline session policy. You can also specify up to 10 managed policies to
|
||||
// use as managed session policies. The plain text that you use for both inline
|
||||
// and managed session policies shouldn't exceed 2048 characters.
|
||||
// and managed session policies can't exceed 2,048 characters.
|
||||
//
|
||||
// Though the session policy parameters are optional, if you do not pass a policy,
|
||||
// then the resulting federated user session has no permissions. The only exception
|
||||
// is when the credentials are used to access a resource that has a resource-based
|
||||
// policy that specifically references the federated user session in the Principal
|
||||
// element of the policy. When you pass session policies, the session permissions
|
||||
// are the intersection of the IAM user policies and the session policies that
|
||||
// you pass. This gives you a way to further restrict the permissions for a
|
||||
// federated user. You cannot use session policies to grant more permissions
|
||||
// than those that are defined in the permissions policy of the IAM user. For
|
||||
// more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session)
|
||||
// then the resulting federated user session has no permissions. When you pass
|
||||
// session policies, the session permissions are the intersection of the IAM
|
||||
// user policies and the session policies that you pass. This gives you a way
|
||||
// to further restrict the permissions for a federated user. You cannot use
|
||||
// session policies to grant more permissions than those that are defined in
|
||||
// the permissions policy of the IAM user. For more information, see Session
|
||||
// Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session)
|
||||
// in the IAM User Guide. For information about using GetFederationToken to
|
||||
// create temporary security credentials, see GetFederationToken—Federation
|
||||
// Through a Custom Identity Broker (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken).
|
||||
//
|
||||
// You can use the credentials to access a resource that has a resource-based
|
||||
// policy. If that policy specifically references the federated user session
|
||||
// in the Principal element of the policy, the session has the permissions allowed
|
||||
// by the policy. These permissions are granted in addition to the permissions
|
||||
// granted by the session policies.
|
||||
//
|
||||
// Tags
|
||||
//
|
||||
// (Optional) You can pass tag key-value pairs to your session. These are called
|
||||
// session tags. For more information about session tags, see Passing Session
|
||||
// Tags in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// An administrator must grant you the permissions necessary to pass session
|
||||
// tags. The administrator can also create granular permissions to allow you
|
||||
// to pass only specific session tags. For more information, see Tutorial: Using
|
||||
// Tags for Attribute-Based Access Control (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Tag key–value pairs are not case sensitive, but case is preserved. This
|
||||
// means that you cannot have separate Department and department tag keys. Assume
|
||||
// that the user that you are federating has the Department=Marketing tag and
|
||||
// you pass the department=engineering session tag. Department and department
|
||||
// are not saved as separate tags, and the session tag passed in the request
|
||||
// takes precedence over the user tag.
|
||||
//
|
||||
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
|
||||
// with awserr.Error's Code and Message methods to get detailed information about
|
||||
// the error.
|
||||
|
|
@ -1000,9 +1158,18 @@ func (c *STS) GetFederationTokenRequest(input *GetFederationTokenInput) (req *re
|
|||
// message describes the specific error.
|
||||
//
|
||||
// * ErrCodePackedPolicyTooLargeException "PackedPolicyTooLarge"
|
||||
// The request was rejected because the policy document was too large. The error
|
||||
// message describes how big the policy document is, in packed form, as a percentage
|
||||
// of what the API allows.
|
||||
// The request was rejected because the total packed size of the session policies
|
||||
// and session tags combined was too large. An AWS conversion compresses the
|
||||
// session policy document, session policy ARNs, and session tags into a packed
|
||||
// binary format that has a separate limit. The error message indicates by percentage
|
||||
// how close the policies and tags are to the upper size limit. For more information,
|
||||
// see Passing Session Tags in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// You could receive this error even though you meet other defined session policy
|
||||
// and session tag limits. For more information, see IAM and STS Entity Character
|
||||
// Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// * ErrCodeRegionDisabledException "RegionDisabledException"
|
||||
// STS is not activated in the requested region for the account that is being
|
||||
|
|
@ -1091,6 +1258,8 @@ func (c *STS) GetSessionTokenRequest(input *GetSessionTokenInput) (req *request.
|
|||
// and Comparing the AWS STS API operations (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Session Duration
|
||||
//
|
||||
// The GetSessionToken operation must be called by using the long-term AWS security
|
||||
// credentials of the AWS account root user or an IAM user. Credentials that
|
||||
// are created by IAM users are valid for the duration that you specify. This
|
||||
|
|
@ -1099,6 +1268,8 @@ func (c *STS) GetSessionTokenRequest(input *GetSessionTokenInput) (req *request.
|
|||
// based on account credentials can range from 900 seconds (15 minutes) up to
|
||||
// 3,600 seconds (1 hour), with a default of 1 hour.
|
||||
//
|
||||
// Permissions
|
||||
//
|
||||
// The temporary security credentials created by GetSessionToken can be used
|
||||
// to make API calls to any AWS service with the following exceptions:
|
||||
//
|
||||
|
|
@ -1213,16 +1384,16 @@ type AssumeRoleInput struct {
|
|||
// in the IAM User Guide.
|
||||
//
|
||||
// The plain text that you use for both inline and managed session policies
|
||||
// shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII
|
||||
// can't exceed 2,048 characters. The JSON policy characters can be any ASCII
|
||||
// character from the space character to the end of the valid character list
|
||||
// (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A),
|
||||
// and carriage return (\u000D) characters.
|
||||
//
|
||||
// The characters in this parameter count towards the 2048 character session
|
||||
// policy guideline. However, an AWS conversion compresses the session policies
|
||||
// into a packed binary format that has a separate limit. This is the enforced
|
||||
// limit. The PackedPolicySize response element indicates by percentage how
|
||||
// close the policy is to the upper size limit.
|
||||
// An AWS conversion compresses the passed session policies and session tags
|
||||
// into a packed binary format that has a separate limit. Your request can fail
|
||||
// for this limit even if your plain text meets the other requirements. The
|
||||
// PackedPolicySize response element indicates by percentage how close the policies
|
||||
// and tags for your request are to the upper size limit.
|
||||
Policy *string `min:"1" type:"string"`
|
||||
|
||||
// The Amazon Resource Names (ARNs) of the IAM managed policies that you want
|
||||
|
|
@ -1231,15 +1402,15 @@ type AssumeRoleInput struct {
|
|||
//
|
||||
// This parameter is optional. You can provide up to 10 managed policy ARNs.
|
||||
// However, the plain text that you use for both inline and managed session
|
||||
// policies shouldn't exceed 2048 characters. For more information about ARNs,
|
||||
// policies can't exceed 2,048 characters. For more information about ARNs,
|
||||
// see Amazon Resource Names (ARNs) and AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
|
||||
// in the AWS General Reference.
|
||||
//
|
||||
// The characters in this parameter count towards the 2048 character session
|
||||
// policy guideline. However, an AWS conversion compresses the session policies
|
||||
// into a packed binary format that has a separate limit. This is the enforced
|
||||
// limit. The PackedPolicySize response element indicates by percentage how
|
||||
// close the policy is to the upper size limit.
|
||||
// An AWS conversion compresses the passed session policies and session tags
|
||||
// into a packed binary format that has a separate limit. Your request can fail
|
||||
// for this limit even if your plain text meets the other requirements. The
|
||||
// PackedPolicySize response element indicates by percentage how close the policies
|
||||
// and tags for your request are to the upper size limit.
|
||||
//
|
||||
// Passing policies to this operation returns new temporary credentials. The
|
||||
// resulting session's permissions are the intersection of the role's identity-based
|
||||
|
|
@ -1284,6 +1455,41 @@ type AssumeRoleInput struct {
|
|||
// also include underscores or any of the following characters: =,.@-
|
||||
SerialNumber *string `min:"9" type:"string"`
|
||||
|
||||
// A list of session tags that you want to pass. Each session tag consists of
|
||||
// a key name and an associated value. For more information about session tags,
|
||||
// see Tagging AWS STS Sessions (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// This parameter is optional. You can pass up to 50 session tags. The plain
|
||||
// text session tag keys can’t exceed 128 characters, and the values can’t
|
||||
// exceed 256 characters. For these and additional limits, see IAM and STS Character
|
||||
// Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// An AWS conversion compresses the passed session policies and session tags
|
||||
// into a packed binary format that has a separate limit. Your request can fail
|
||||
// for this limit even if your plain text meets the other requirements. The
|
||||
// PackedPolicySize response element indicates by percentage how close the policies
|
||||
// and tags for your request are to the upper size limit.
|
||||
//
|
||||
// You can pass a session tag with the same key as a tag that is already attached
|
||||
// to the role. When you do, session tags override a role tag with the same
|
||||
// key.
|
||||
//
|
||||
// Tag key–value pairs are not case sensitive, but case is preserved. This
|
||||
// means that you cannot have separate Department and department tag keys. Assume
|
||||
// that the role has the Department=Marketing tag and you pass the department=engineering
|
||||
// session tag. Department and department are not saved as separate tags, and
|
||||
// the session tag passed in the request takes precedence over the role tag.
|
||||
//
|
||||
// Additionally, if you used temporary credentials to perform this operation,
|
||||
// the new session inherits any transitive session tags from the calling session.
|
||||
// If you pass a session tag with the same key as an inherited tag, the operation
|
||||
// fails. To view the inherited tags for a session, see the AWS CloudTrail logs.
|
||||
// For more information, see Viewing Session Tags in CloudTrail (https://docs.aws.amazon.com/IAM/latest/UserGuide/session-tags.html#id_session-tags_ctlogs)
|
||||
// in the IAM User Guide.
|
||||
Tags []*Tag `type:"list"`
|
||||
|
||||
// The value provided by the MFA device, if the trust policy of the role being
|
||||
// assumed requires MFA (that is, if the policy includes a condition that tests
|
||||
// for MFA). If the role being assumed requires MFA and if the TokenCode value
|
||||
|
|
@ -1292,6 +1498,19 @@ type AssumeRoleInput struct {
|
|||
// The format for this parameter, as described by its regex pattern, is a sequence
|
||||
// of six numeric digits.
|
||||
TokenCode *string `min:"6" type:"string"`
|
||||
|
||||
// A list of keys for session tags that you want to set as transitive. If you
|
||||
// set a tag key as transitive, the corresponding key and value passes to subsequent
|
||||
// sessions in a role chain. For more information, see Chaining Roles with Session
|
||||
// Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// This parameter is optional. When you set session tags as transitive, the
|
||||
// session policy and session tags packed binary limit is not affected.
|
||||
//
|
||||
// If you choose not to specify a transitive tag key, then no tags are passed
|
||||
// from this session to any subsequent sessions.
|
||||
TransitiveTagKeys []*string `type:"list"`
|
||||
}
|
||||
|
||||
// String returns the string representation
|
||||
|
|
@ -1344,6 +1563,16 @@ func (s *AssumeRoleInput) Validate() error {
|
|||
}
|
||||
}
|
||||
}
|
||||
if s.Tags != nil {
|
||||
for i, v := range s.Tags {
|
||||
if v == nil {
|
||||
continue
|
||||
}
|
||||
if err := v.Validate(); err != nil {
|
||||
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if invalidParams.Len() > 0 {
|
||||
return invalidParams
|
||||
|
|
@ -1393,12 +1622,24 @@ func (s *AssumeRoleInput) SetSerialNumber(v string) *AssumeRoleInput {
|
|||
return s
|
||||
}
|
||||
|
||||
// SetTags sets the Tags field's value.
|
||||
func (s *AssumeRoleInput) SetTags(v []*Tag) *AssumeRoleInput {
|
||||
s.Tags = v
|
||||
return s
|
||||
}
|
||||
|
||||
// SetTokenCode sets the TokenCode field's value.
|
||||
func (s *AssumeRoleInput) SetTokenCode(v string) *AssumeRoleInput {
|
||||
s.TokenCode = &v
|
||||
return s
|
||||
}
|
||||
|
||||
// SetTransitiveTagKeys sets the TransitiveTagKeys field's value.
|
||||
func (s *AssumeRoleInput) SetTransitiveTagKeys(v []*string) *AssumeRoleInput {
|
||||
s.TransitiveTagKeys = v
|
||||
return s
|
||||
}
|
||||
|
||||
// Contains the response to a successful AssumeRole request, including temporary
|
||||
// AWS credentials that can be used to make AWS requests.
|
||||
type AssumeRoleOutput struct {
|
||||
|
|
@ -1418,9 +1659,10 @@ type AssumeRoleOutput struct {
|
|||
// We strongly recommend that you make no assumptions about the maximum size.
|
||||
Credentials *Credentials `type:"structure"`
|
||||
|
||||
// A percentage value that indicates the size of the policy in packed form.
|
||||
// The service rejects any policy with a packed size greater than 100 percent,
|
||||
// which means the policy exceeded the allowed space.
|
||||
// A percentage value that indicates the packed size of the session policies
|
||||
// and session tags combined passed in the request. The request fails if the
|
||||
// packed size is greater than 100 percent, which means the policies and tags
|
||||
// exceeded the allowed space.
|
||||
PackedPolicySize *int64 `type:"integer"`
|
||||
}
|
||||
|
||||
|
|
@ -1491,16 +1733,16 @@ type AssumeRoleWithSAMLInput struct {
|
|||
// in the IAM User Guide.
|
||||
//
|
||||
// The plain text that you use for both inline and managed session policies
|
||||
// shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII
|
||||
// can't exceed 2,048 characters. The JSON policy characters can be any ASCII
|
||||
// character from the space character to the end of the valid character list
|
||||
// (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A),
|
||||
// and carriage return (\u000D) characters.
|
||||
//
|
||||
// The characters in this parameter count towards the 2048 character session
|
||||
// policy guideline. However, an AWS conversion compresses the session policies
|
||||
// into a packed binary format that has a separate limit. This is the enforced
|
||||
// limit. The PackedPolicySize response element indicates by percentage how
|
||||
// close the policy is to the upper size limit.
|
||||
// An AWS conversion compresses the passed session policies and session tags
|
||||
// into a packed binary format that has a separate limit. Your request can fail
|
||||
// for this limit even if your plain text meets the other requirements. The
|
||||
// PackedPolicySize response element indicates by percentage how close the policies
|
||||
// and tags for your request are to the upper size limit.
|
||||
Policy *string `min:"1" type:"string"`
|
||||
|
||||
// The Amazon Resource Names (ARNs) of the IAM managed policies that you want
|
||||
|
|
@ -1509,15 +1751,15 @@ type AssumeRoleWithSAMLInput struct {
|
|||
//
|
||||
// This parameter is optional. You can provide up to 10 managed policy ARNs.
|
||||
// However, the plain text that you use for both inline and managed session
|
||||
// policies shouldn't exceed 2048 characters. For more information about ARNs,
|
||||
// policies can't exceed 2,048 characters. For more information about ARNs,
|
||||
// see Amazon Resource Names (ARNs) and AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
|
||||
// in the AWS General Reference.
|
||||
//
|
||||
// The characters in this parameter count towards the 2048 character session
|
||||
// policy guideline. However, an AWS conversion compresses the session policies
|
||||
// into a packed binary format that has a separate limit. This is the enforced
|
||||
// limit. The PackedPolicySize response element indicates by percentage how
|
||||
// close the policy is to the upper size limit.
|
||||
// An AWS conversion compresses the passed session policies and session tags
|
||||
// into a packed binary format that has a separate limit. Your request can fail
|
||||
// for this limit even if your plain text meets the other requirements. The
|
||||
// PackedPolicySize response element indicates by percentage how close the policies
|
||||
// and tags for your request are to the upper size limit.
|
||||
//
|
||||
// Passing policies to this operation returns new temporary credentials. The
|
||||
// resulting session's permissions are the intersection of the role's identity-based
|
||||
|
|
@ -1673,9 +1915,10 @@ type AssumeRoleWithSAMLOutput struct {
|
|||
// ) )
|
||||
NameQualifier *string `type:"string"`
|
||||
|
||||
// A percentage value that indicates the size of the policy in packed form.
|
||||
// The service rejects any policy with a packed size greater than 100 percent,
|
||||
// which means the policy exceeded the allowed space.
|
||||
// A percentage value that indicates the packed size of the session policies
|
||||
// and session tags combined passed in the request. The request fails if the
|
||||
// packed size is greater than 100 percent, which means the policies and tags
|
||||
// exceeded the allowed space.
|
||||
PackedPolicySize *int64 `type:"integer"`
|
||||
|
||||
// The value of the NameID element in the Subject element of the SAML assertion.
|
||||
|
|
@ -1786,16 +2029,16 @@ type AssumeRoleWithWebIdentityInput struct {
|
|||
// in the IAM User Guide.
|
||||
//
|
||||
// The plain text that you use for both inline and managed session policies
|
||||
// shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII
|
||||
// can't exceed 2,048 characters. The JSON policy characters can be any ASCII
|
||||
// character from the space character to the end of the valid character list
|
||||
// (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A),
|
||||
// and carriage return (\u000D) characters.
|
||||
//
|
||||
// The characters in this parameter count towards the 2048 character session
|
||||
// policy guideline. However, an AWS conversion compresses the session policies
|
||||
// into a packed binary format that has a separate limit. This is the enforced
|
||||
// limit. The PackedPolicySize response element indicates by percentage how
|
||||
// close the policy is to the upper size limit.
|
||||
// An AWS conversion compresses the passed session policies and session tags
|
||||
// into a packed binary format that has a separate limit. Your request can fail
|
||||
// for this limit even if your plain text meets the other requirements. The
|
||||
// PackedPolicySize response element indicates by percentage how close the policies
|
||||
// and tags for your request are to the upper size limit.
|
||||
Policy *string `min:"1" type:"string"`
|
||||
|
||||
// The Amazon Resource Names (ARNs) of the IAM managed policies that you want
|
||||
|
|
@ -1804,15 +2047,15 @@ type AssumeRoleWithWebIdentityInput struct {
|
|||
//
|
||||
// This parameter is optional. You can provide up to 10 managed policy ARNs.
|
||||
// However, the plain text that you use for both inline and managed session
|
||||
// policies shouldn't exceed 2048 characters. For more information about ARNs,
|
||||
// policies can't exceed 2,048 characters. For more information about ARNs,
|
||||
// see Amazon Resource Names (ARNs) and AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
|
||||
// in the AWS General Reference.
|
||||
//
|
||||
// The characters in this parameter count towards the 2048 character session
|
||||
// policy guideline. However, an AWS conversion compresses the session policies
|
||||
// into a packed binary format that has a separate limit. This is the enforced
|
||||
// limit. The PackedPolicySize response element indicates by percentage how
|
||||
// close the policy is to the upper size limit.
|
||||
// An AWS conversion compresses the passed session policies and session tags
|
||||
// into a packed binary format that has a separate limit. Your request can fail
|
||||
// for this limit even if your plain text meets the other requirements. The
|
||||
// PackedPolicySize response element indicates by percentage how close the policies
|
||||
// and tags for your request are to the upper size limit.
|
||||
//
|
||||
// Passing policies to this operation returns new temporary credentials. The
|
||||
// resulting session's permissions are the intersection of the role's identity-based
|
||||
|
|
@ -1983,9 +2226,10 @@ type AssumeRoleWithWebIdentityOutput struct {
|
|||
// We strongly recommend that you make no assumptions about the maximum size.
|
||||
Credentials *Credentials `type:"structure"`
|
||||
|
||||
// A percentage value that indicates the size of the policy in packed form.
|
||||
// The service rejects any policy with a packed size greater than 100 percent,
|
||||
// which means the policy exceeded the allowed space.
|
||||
// A percentage value that indicates the packed size of the session policies
|
||||
// and session tags combined passed in the request. The request fails if the
|
||||
// packed size is greater than 100 percent, which means the policies and tags
|
||||
// exceeded the allowed space.
|
||||
PackedPolicySize *int64 `type:"integer"`
|
||||
|
||||
// The issuing authority of the web identity token presented. For OpenID Connect
|
||||
|
|
@ -2057,7 +2301,7 @@ type AssumedRoleUser struct {
|
|||
// The ARN of the temporary security credentials that are returned from the
|
||||
// AssumeRole action. For more information about ARNs and how to use them in
|
||||
// policies, see IAM Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
|
||||
// in Using IAM.
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Arn is a required field
|
||||
Arn *string `min:"20" type:"string" required:"true"`
|
||||
|
|
@ -2225,7 +2469,7 @@ type FederatedUser struct {
|
|||
// The ARN that specifies the federated user that is associated with the credentials.
|
||||
// For more information about ARNs and how to use them in policies, see IAM
|
||||
// Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
|
||||
// in Using IAM.
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Arn is a required field
|
||||
Arn *string `min:"20" type:"string" required:"true"`
|
||||
|
|
@ -2265,7 +2509,7 @@ type GetAccessKeyInfoInput struct {
|
|||
// The identifier of an access key.
|
||||
//
|
||||
// This parameter allows (through its regex pattern) a string of characters
|
||||
// that can consist of any upper- or lowercased letter or digit.
|
||||
// that can consist of any upper- or lowercase letter or digit.
|
||||
//
|
||||
// AccessKeyId is a required field
|
||||
AccessKeyId *string `min:"16" type:"string" required:"true"`
|
||||
|
|
@ -2418,10 +2662,7 @@ type GetFederationTokenInput struct {
|
|||
// use as managed session policies.
|
||||
//
|
||||
// This parameter is optional. However, if you do not pass any session policies,
|
||||
// then the resulting federated user session has no permissions. The only exception
|
||||
// is when the credentials are used to access a resource that has a resource-based
|
||||
// policy that specifically references the federated user session in the Principal
|
||||
// element of the policy.
|
||||
// then the resulting federated user session has no permissions.
|
||||
//
|
||||
// When you pass session policies, the session permissions are the intersection
|
||||
// of the IAM user policies and the session policies that you pass. This gives
|
||||
|
|
@ -2431,17 +2672,23 @@ type GetFederationTokenInput struct {
|
|||
// Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// The resulting credentials can be used to access a resource that has a resource-based
|
||||
// policy. If that policy specifically references the federated user session
|
||||
// in the Principal element of the policy, the session has the permissions allowed
|
||||
// by the policy. These permissions are granted in addition to the permissions
|
||||
// that are granted by the session policies.
|
||||
//
|
||||
// The plain text that you use for both inline and managed session policies
|
||||
// shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII
|
||||
// can't exceed 2,048 characters. The JSON policy characters can be any ASCII
|
||||
// character from the space character to the end of the valid character list
|
||||
// (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A),
|
||||
// and carriage return (\u000D) characters.
|
||||
//
|
||||
// The characters in this parameter count towards the 2048 character session
|
||||
// policy guideline. However, an AWS conversion compresses the session policies
|
||||
// into a packed binary format that has a separate limit. This is the enforced
|
||||
// limit. The PackedPolicySize response element indicates by percentage how
|
||||
// close the policy is to the upper size limit.
|
||||
// An AWS conversion compresses the passed session policies and session tags
|
||||
// into a packed binary format that has a separate limit. Your request can fail
|
||||
// for this limit even if your plain text meets the other requirements. The
|
||||
// PackedPolicySize response element indicates by percentage how close the policies
|
||||
// and tags for your request are to the upper size limit.
|
||||
Policy *string `min:"1" type:"string"`
|
||||
|
||||
// The Amazon Resource Names (ARNs) of the IAM managed policies that you want
|
||||
|
|
@ -2452,16 +2699,13 @@ type GetFederationTokenInput struct {
|
|||
// to this operation. You can pass a single JSON policy document to use as an
|
||||
// inline session policy. You can also specify up to 10 managed policies to
|
||||
// use as managed session policies. The plain text that you use for both inline
|
||||
// and managed session policies shouldn't exceed 2048 characters. You can provide
|
||||
// and managed session policies can't exceed 2,048 characters. You can provide
|
||||
// up to 10 managed policy ARNs. For more information about ARNs, see Amazon
|
||||
// Resource Names (ARNs) and AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
|
||||
// in the AWS General Reference.
|
||||
//
|
||||
// This parameter is optional. However, if you do not pass any session policies,
|
||||
// then the resulting federated user session has no permissions. The only exception
|
||||
// is when the credentials are used to access a resource that has a resource-based
|
||||
// policy that specifically references the federated user session in the Principal
|
||||
// element of the policy.
|
||||
// then the resulting federated user session has no permissions.
|
||||
//
|
||||
// When you pass session policies, the session permissions are the intersection
|
||||
// of the IAM user policies and the session policies that you pass. This gives
|
||||
|
|
@ -2471,12 +2715,46 @@ type GetFederationTokenInput struct {
|
|||
// Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// The characters in this parameter count towards the 2048 character session
|
||||
// policy guideline. However, an AWS conversion compresses the session policies
|
||||
// into a packed binary format that has a separate limit. This is the enforced
|
||||
// limit. The PackedPolicySize response element indicates by percentage how
|
||||
// close the policy is to the upper size limit.
|
||||
// The resulting credentials can be used to access a resource that has a resource-based
|
||||
// policy. If that policy specifically references the federated user session
|
||||
// in the Principal element of the policy, the session has the permissions allowed
|
||||
// by the policy. These permissions are granted in addition to the permissions
|
||||
// that are granted by the session policies.
|
||||
//
|
||||
// An AWS conversion compresses the passed session policies and session tags
|
||||
// into a packed binary format that has a separate limit. Your request can fail
|
||||
// for this limit even if your plain text meets the other requirements. The
|
||||
// PackedPolicySize response element indicates by percentage how close the policies
|
||||
// and tags for your request are to the upper size limit.
|
||||
PolicyArns []*PolicyDescriptorType `type:"list"`
|
||||
|
||||
// A list of session tags. Each session tag consists of a key name and an associated
|
||||
// value. For more information about session tags, see Passing Session Tags
|
||||
// in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// This parameter is optional. You can pass up to 50 session tags. The plain
|
||||
// text session tag keys can’t exceed 128 characters and the values can’t
|
||||
// exceed 256 characters. For these and additional limits, see IAM and STS Character
|
||||
// Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// An AWS conversion compresses the passed session policies and session tags
|
||||
// into a packed binary format that has a separate limit. Your request can fail
|
||||
// for this limit even if your plain text meets the other requirements. The
|
||||
// PackedPolicySize response element indicates by percentage how close the policies
|
||||
// and tags for your request are to the upper size limit.
|
||||
//
|
||||
// You can pass a session tag with the same key as a tag that is already attached
|
||||
// to the user you are federating. When you do, session tags override a user
|
||||
// tag with the same key.
|
||||
//
|
||||
// Tag key–value pairs are not case sensitive, but case is preserved. This
|
||||
// means that you cannot have separate Department and department tag keys. Assume
|
||||
// that the role has the Department=Marketing tag and you pass the department=engineering
|
||||
// session tag. Department and department are not saved as separate tags, and
|
||||
// the session tag passed in the request takes precedence over the role tag.
|
||||
Tags []*Tag `type:"list"`
|
||||
}
|
||||
|
||||
// String returns the string representation
|
||||
|
|
@ -2514,6 +2792,16 @@ func (s *GetFederationTokenInput) Validate() error {
|
|||
}
|
||||
}
|
||||
}
|
||||
if s.Tags != nil {
|
||||
for i, v := range s.Tags {
|
||||
if v == nil {
|
||||
continue
|
||||
}
|
||||
if err := v.Validate(); err != nil {
|
||||
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if invalidParams.Len() > 0 {
|
||||
return invalidParams
|
||||
|
|
@ -2545,6 +2833,12 @@ func (s *GetFederationTokenInput) SetPolicyArns(v []*PolicyDescriptorType) *GetF
|
|||
return s
|
||||
}
|
||||
|
||||
// SetTags sets the Tags field's value.
|
||||
func (s *GetFederationTokenInput) SetTags(v []*Tag) *GetFederationTokenInput {
|
||||
s.Tags = v
|
||||
return s
|
||||
}
|
||||
|
||||
// Contains the response to a successful GetFederationToken request, including
|
||||
// temporary AWS credentials that can be used to make AWS requests.
|
||||
type GetFederationTokenOutput struct {
|
||||
|
|
@ -2563,9 +2857,10 @@ type GetFederationTokenOutput struct {
|
|||
// an Amazon S3 bucket policy.
|
||||
FederatedUser *FederatedUser `type:"structure"`
|
||||
|
||||
// A percentage value indicating the size of the policy in packed form. The
|
||||
// service rejects policies for which the packed size is greater than 100 percent
|
||||
// of the allowed value.
|
||||
// A percentage value that indicates the packed size of the session policies
|
||||
// and session tags combined passed in the request. The request fails if the
|
||||
// packed size is greater than 100 percent, which means the policies and tags
|
||||
// exceeded the allowed space.
|
||||
PackedPolicySize *int64 `type:"integer"`
|
||||
}
|
||||
|
||||
|
|
@ -2748,3 +3043,73 @@ func (s *PolicyDescriptorType) SetArn(v string) *PolicyDescriptorType {
|
|||
s.Arn = &v
|
||||
return s
|
||||
}
|
||||
|
||||
// You can pass custom key-value pair attributes when you assume a role or federate
|
||||
// a user. These are called session tags. You can then use the session tags
|
||||
// to control access to resources. For more information, see Tagging AWS STS
|
||||
// Sessions (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html)
|
||||
// in the IAM User Guide.
|
||||
type Tag struct {
|
||||
_ struct{} `type:"structure"`
|
||||
|
||||
// The key for a session tag.
|
||||
//
|
||||
// You can pass up to 50 session tags. The plain text session tag keys can’t
|
||||
// exceed 128 characters. For these and additional limits, see IAM and STS Character
|
||||
// Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Key is a required field
|
||||
Key *string `min:"1" type:"string" required:"true"`
|
||||
|
||||
// The value for a session tag.
|
||||
//
|
||||
// You can pass up to 50 session tags. The plain text session tag values can’t
|
||||
// exceed 256 characters. For these and additional limits, see IAM and STS Character
|
||||
// Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// Value is a required field
|
||||
Value *string `type:"string" required:"true"`
|
||||
}
|
||||
|
||||
// String returns the string representation
|
||||
func (s Tag) String() string {
|
||||
return awsutil.Prettify(s)
|
||||
}
|
||||
|
||||
// GoString returns the string representation
|
||||
func (s Tag) GoString() string {
|
||||
return s.String()
|
||||
}
|
||||
|
||||
// Validate inspects the fields of the type to determine if they are valid.
|
||||
func (s *Tag) Validate() error {
|
||||
invalidParams := request.ErrInvalidParams{Context: "Tag"}
|
||||
if s.Key == nil {
|
||||
invalidParams.Add(request.NewErrParamRequired("Key"))
|
||||
}
|
||||
if s.Key != nil && len(*s.Key) < 1 {
|
||||
invalidParams.Add(request.NewErrParamMinLen("Key", 1))
|
||||
}
|
||||
if s.Value == nil {
|
||||
invalidParams.Add(request.NewErrParamRequired("Value"))
|
||||
}
|
||||
|
||||
if invalidParams.Len() > 0 {
|
||||
return invalidParams
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// SetKey sets the Key field's value.
|
||||
func (s *Tag) SetKey(v string) *Tag {
|
||||
s.Key = &v
|
||||
return s
|
||||
}
|
||||
|
||||
// SetValue sets the Value field's value.
|
||||
func (s *Tag) SetValue(v string) *Tag {
|
||||
s.Value = &v
|
||||
return s
|
||||
}
|
||||
|
|
|
|||
|
|
@ -14,11 +14,11 @@ const (
|
|||
// ErrCodeIDPCommunicationErrorException for service response error code
|
||||
// "IDPCommunicationError".
|
||||
//
|
||||
// The request could not be fulfilled because the non-AWS identity provider
|
||||
// (IDP) that was asked to verify the incoming identity token could not be reached.
|
||||
// This is often a transient error caused by network conditions. Retry the request
|
||||
// The request could not be fulfilled because the identity provider (IDP) that
|
||||
// was asked to verify the incoming identity token could not be reached. This
|
||||
// is often a transient error caused by network conditions. Retry the request
|
||||
// a limited number of times so that you don't exceed the request rate. If the
|
||||
// error persists, the non-AWS identity provider might be down or not responding.
|
||||
// error persists, the identity provider might be down or not responding.
|
||||
ErrCodeIDPCommunicationErrorException = "IDPCommunicationError"
|
||||
|
||||
// ErrCodeIDPRejectedClaimException for service response error code
|
||||
|
|
@ -34,9 +34,9 @@ const (
|
|||
// ErrCodeInvalidAuthorizationMessageException for service response error code
|
||||
// "InvalidAuthorizationMessageException".
|
||||
//
|
||||
// This error is returned if the message passed to DecodeAuthorizationMessage
|
||||
// was invalid. This can happen if the token contains invalid characters, such
|
||||
// as linebreaks.
|
||||
// The error returned if the message passed to DecodeAuthorizationMessage was
|
||||
// invalid. This can happen if the token contains invalid characters, such as
|
||||
// linebreaks.
|
||||
ErrCodeInvalidAuthorizationMessageException = "InvalidAuthorizationMessageException"
|
||||
|
||||
// ErrCodeInvalidIdentityTokenException for service response error code
|
||||
|
|
@ -56,9 +56,18 @@ const (
|
|||
// ErrCodePackedPolicyTooLargeException for service response error code
|
||||
// "PackedPolicyTooLarge".
|
||||
//
|
||||
// The request was rejected because the policy document was too large. The error
|
||||
// message describes how big the policy document is, in packed form, as a percentage
|
||||
// of what the API allows.
|
||||
// The request was rejected because the total packed size of the session policies
|
||||
// and session tags combined was too large. An AWS conversion compresses the
|
||||
// session policy document, session policy ARNs, and session tags into a packed
|
||||
// binary format that has a separate limit. The error message indicates by percentage
|
||||
// how close the policies and tags are to the upper size limit. For more information,
|
||||
// see Passing Session Tags in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html)
|
||||
// in the IAM User Guide.
|
||||
//
|
||||
// You could receive this error even though you meet other defined session policy
|
||||
// and session tag limits. For more information, see IAM and STS Entity Character
|
||||
// Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html)
|
||||
// in the IAM User Guide.
|
||||
ErrCodePackedPolicyTooLargeException = "PackedPolicyTooLarge"
|
||||
|
||||
// ErrCodeRegionDisabledException for service response error code
|
||||
|
|
|
|||
|
|
@ -39,6 +39,8 @@ const (
|
|||
// aws.Config parameter to add your extra config.
|
||||
//
|
||||
// Example:
|
||||
// mySession := session.Must(session.NewSession())
|
||||
//
|
||||
// // Create a STS client from just a session.
|
||||
// svc := sts.New(mySession)
|
||||
//
|
||||
|
|
|
|||
|
|
@ -0,0 +1,37 @@
|
|||
# Binaries for programs and plugins
|
||||
*.exe
|
||||
*.dll
|
||||
*.so
|
||||
*.dylib
|
||||
*.o
|
||||
*.a
|
||||
|
||||
# Folders
|
||||
_obj
|
||||
_test
|
||||
|
||||
# Architecture specific extensions/prefixes
|
||||
*.[568vq]
|
||||
[568vq].out
|
||||
|
||||
*.cgo1.go
|
||||
*.cgo2.c
|
||||
_cgo_defun.c
|
||||
_cgo_gotypes.go
|
||||
_cgo_export.*
|
||||
|
||||
_testmain.go
|
||||
|
||||
*.prof
|
||||
|
||||
# Test binary, build with `go test -c`
|
||||
*.test
|
||||
|
||||
# Output of the go coverage tool, specifically when used with LiteIDE
|
||||
*.out
|
||||
|
||||
# Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736
|
||||
.glide/
|
||||
|
||||
# Gogland
|
||||
.idea/
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
language: go
|
||||
|
||||
go:
|
||||
- '1.10'
|
||||
- '1.11'
|
||||
|
||||
# sudo=false makes the build run using a container
|
||||
sudo: false
|
||||
|
||||
before_install:
|
||||
- go get github.com/mattn/goveralls
|
||||
- go get golang.org/x/tools/cmd/cover
|
||||
- go get golang.org/x/tools/cmd/goimports
|
||||
- go get github.com/golang/lint/golint
|
||||
script:
|
||||
- gofiles=$(find ./ -name '*.go') && [ -z "$gofiles" ] || unformatted=$(goimports -l $gofiles) && [ -z "$unformatted" ] || (echo >&2 "Go files must be formatted with gofmt. Following files has problem:\n $unformatted" && false)
|
||||
- golint ./... # This won't break the build, just show warnings
|
||||
- $HOME/gopath/bin/goveralls -service=travis-ci
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright {yyyy} {name of copyright owner}
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
# utfbom [](https://godoc.org/github.com/dimchansky/utfbom) [](https://opensource.org/licenses/Apache-2.0) [](https://travis-ci.org/dimchansky/utfbom) [](https://goreportcard.com/report/github.com/dimchansky/utfbom) [](https://coveralls.io/github/dimchansky/utfbom?branch=master)
|
||||
|
||||
The package utfbom implements the detection of the BOM (Unicode Byte Order Mark) and removing as necessary. It can also return the encoding detected by the BOM.
|
||||
|
||||
## Installation
|
||||
|
||||
go get -u github.com/dimchansky/utfbom
|
||||
|
||||
## Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
|
||||
"github.com/dimchansky/utfbom"
|
||||
)
|
||||
|
||||
func main() {
|
||||
trySkip([]byte("\xEF\xBB\xBFhello"))
|
||||
trySkip([]byte("hello"))
|
||||
}
|
||||
|
||||
func trySkip(byteData []byte) {
|
||||
fmt.Println("Input:", byteData)
|
||||
|
||||
// just skip BOM
|
||||
output, err := ioutil.ReadAll(utfbom.SkipOnly(bytes.NewReader(byteData)))
|
||||
if err != nil {
|
||||
fmt.Println(err)
|
||||
return
|
||||
}
|
||||
fmt.Println("ReadAll with BOM skipping", output)
|
||||
|
||||
// skip BOM and detect encoding
|
||||
sr, enc := utfbom.Skip(bytes.NewReader(byteData))
|
||||
fmt.Printf("Detected encoding: %s\n", enc)
|
||||
output, err = ioutil.ReadAll(sr)
|
||||
if err != nil {
|
||||
fmt.Println(err)
|
||||
return
|
||||
}
|
||||
fmt.Println("ReadAll with BOM detection and skipping", output)
|
||||
fmt.Println()
|
||||
}
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```
|
||||
$ go run main.go
|
||||
Input: [239 187 191 104 101 108 108 111]
|
||||
ReadAll with BOM skipping [104 101 108 108 111]
|
||||
Detected encoding: UTF8
|
||||
ReadAll with BOM detection and skipping [104 101 108 108 111]
|
||||
|
||||
Input: [104 101 108 108 111]
|
||||
ReadAll with BOM skipping [104 101 108 108 111]
|
||||
Detected encoding: Unknown
|
||||
ReadAll with BOM detection and skipping [104 101 108 108 111]
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
module github.com/dimchansky/utfbom
|
||||
|
|
@ -0,0 +1,192 @@
|
|||
// Package utfbom implements the detection of the BOM (Unicode Byte Order Mark) and removing as necessary.
|
||||
// It wraps an io.Reader object, creating another object (Reader) that also implements the io.Reader
|
||||
// interface but provides automatic BOM checking and removing as necessary.
|
||||
package utfbom
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"io"
|
||||
)
|
||||
|
||||
// Encoding is type alias for detected UTF encoding.
|
||||
type Encoding int
|
||||
|
||||
// Constants to identify detected UTF encodings.
|
||||
const (
|
||||
// Unknown encoding, returned when no BOM was detected
|
||||
Unknown Encoding = iota
|
||||
|
||||
// UTF8, BOM bytes: EF BB BF
|
||||
UTF8
|
||||
|
||||
// UTF-16, big-endian, BOM bytes: FE FF
|
||||
UTF16BigEndian
|
||||
|
||||
// UTF-16, little-endian, BOM bytes: FF FE
|
||||
UTF16LittleEndian
|
||||
|
||||
// UTF-32, big-endian, BOM bytes: 00 00 FE FF
|
||||
UTF32BigEndian
|
||||
|
||||
// UTF-32, little-endian, BOM bytes: FF FE 00 00
|
||||
UTF32LittleEndian
|
||||
)
|
||||
|
||||
// String returns a user-friendly string representation of the encoding. Satisfies fmt.Stringer interface.
|
||||
func (e Encoding) String() string {
|
||||
switch e {
|
||||
case UTF8:
|
||||
return "UTF8"
|
||||
case UTF16BigEndian:
|
||||
return "UTF16BigEndian"
|
||||
case UTF16LittleEndian:
|
||||
return "UTF16LittleEndian"
|
||||
case UTF32BigEndian:
|
||||
return "UTF32BigEndian"
|
||||
case UTF32LittleEndian:
|
||||
return "UTF32LittleEndian"
|
||||
default:
|
||||
return "Unknown"
|
||||
}
|
||||
}
|
||||
|
||||
const maxConsecutiveEmptyReads = 100
|
||||
|
||||
// Skip creates Reader which automatically detects BOM (Unicode Byte Order Mark) and removes it as necessary.
|
||||
// It also returns the encoding detected by the BOM.
|
||||
// If the detected encoding is not needed, you can call the SkipOnly function.
|
||||
func Skip(rd io.Reader) (*Reader, Encoding) {
|
||||
// Is it already a Reader?
|
||||
b, ok := rd.(*Reader)
|
||||
if ok {
|
||||
return b, Unknown
|
||||
}
|
||||
|
||||
enc, left, err := detectUtf(rd)
|
||||
return &Reader{
|
||||
rd: rd,
|
||||
buf: left,
|
||||
err: err,
|
||||
}, enc
|
||||
}
|
||||
|
||||
// SkipOnly creates Reader which automatically detects BOM (Unicode Byte Order Mark) and removes it as necessary.
|
||||
func SkipOnly(rd io.Reader) *Reader {
|
||||
r, _ := Skip(rd)
|
||||
return r
|
||||
}
|
||||
|
||||
// Reader implements automatic BOM (Unicode Byte Order Mark) checking and
|
||||
// removing as necessary for an io.Reader object.
|
||||
type Reader struct {
|
||||
rd io.Reader // reader provided by the client
|
||||
buf []byte // buffered data
|
||||
err error // last error
|
||||
}
|
||||
|
||||
// Read is an implementation of io.Reader interface.
|
||||
// The bytes are taken from the underlying Reader, but it checks for BOMs, removing them as necessary.
|
||||
func (r *Reader) Read(p []byte) (n int, err error) {
|
||||
if len(p) == 0 {
|
||||
return 0, nil
|
||||
}
|
||||
|
||||
if r.buf == nil {
|
||||
if r.err != nil {
|
||||
return 0, r.readErr()
|
||||
}
|
||||
|
||||
return r.rd.Read(p)
|
||||
}
|
||||
|
||||
// copy as much as we can
|
||||
n = copy(p, r.buf)
|
||||
r.buf = nilIfEmpty(r.buf[n:])
|
||||
return n, nil
|
||||
}
|
||||
|
||||
func (r *Reader) readErr() error {
|
||||
err := r.err
|
||||
r.err = nil
|
||||
return err
|
||||
}
|
||||
|
||||
var errNegativeRead = errors.New("utfbom: reader returned negative count from Read")
|
||||
|
||||
func detectUtf(rd io.Reader) (enc Encoding, buf []byte, err error) {
|
||||
buf, err = readBOM(rd)
|
||||
|
||||
if len(buf) >= 4 {
|
||||
if isUTF32BigEndianBOM4(buf) {
|
||||
return UTF32BigEndian, nilIfEmpty(buf[4:]), err
|
||||
}
|
||||
if isUTF32LittleEndianBOM4(buf) {
|
||||
return UTF32LittleEndian, nilIfEmpty(buf[4:]), err
|
||||
}
|
||||
}
|
||||
|
||||
if len(buf) > 2 && isUTF8BOM3(buf) {
|
||||
return UTF8, nilIfEmpty(buf[3:]), err
|
||||
}
|
||||
|
||||
if (err != nil && err != io.EOF) || (len(buf) < 2) {
|
||||
return Unknown, nilIfEmpty(buf), err
|
||||
}
|
||||
|
||||
if isUTF16BigEndianBOM2(buf) {
|
||||
return UTF16BigEndian, nilIfEmpty(buf[2:]), err
|
||||
}
|
||||
if isUTF16LittleEndianBOM2(buf) {
|
||||
return UTF16LittleEndian, nilIfEmpty(buf[2:]), err
|
||||
}
|
||||
|
||||
return Unknown, nilIfEmpty(buf), err
|
||||
}
|
||||
|
||||
func readBOM(rd io.Reader) (buf []byte, err error) {
|
||||
const maxBOMSize = 4
|
||||
var bom [maxBOMSize]byte // used to read BOM
|
||||
|
||||
// read as many bytes as possible
|
||||
for nEmpty, n := 0, 0; err == nil && len(buf) < maxBOMSize; buf = bom[:len(buf)+n] {
|
||||
if n, err = rd.Read(bom[len(buf):]); n < 0 {
|
||||
panic(errNegativeRead)
|
||||
}
|
||||
if n > 0 {
|
||||
nEmpty = 0
|
||||
} else {
|
||||
nEmpty++
|
||||
if nEmpty >= maxConsecutiveEmptyReads {
|
||||
err = io.ErrNoProgress
|
||||
}
|
||||
}
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
func isUTF32BigEndianBOM4(buf []byte) bool {
|
||||
return buf[0] == 0x00 && buf[1] == 0x00 && buf[2] == 0xFE && buf[3] == 0xFF
|
||||
}
|
||||
|
||||
func isUTF32LittleEndianBOM4(buf []byte) bool {
|
||||
return buf[0] == 0xFF && buf[1] == 0xFE && buf[2] == 0x00 && buf[3] == 0x00
|
||||
}
|
||||
|
||||
func isUTF8BOM3(buf []byte) bool {
|
||||
return buf[0] == 0xEF && buf[1] == 0xBB && buf[2] == 0xBF
|
||||
}
|
||||
|
||||
func isUTF16BigEndianBOM2(buf []byte) bool {
|
||||
return buf[0] == 0xFE && buf[1] == 0xFF
|
||||
}
|
||||
|
||||
func isUTF16LittleEndianBOM2(buf []byte) bool {
|
||||
return buf[0] == 0xFF && buf[1] == 0xFE
|
||||
}
|
||||
|
||||
func nilIfEmpty(buf []byte) (res []byte) {
|
||||
if len(buf) > 0 {
|
||||
res = buf
|
||||
}
|
||||
return
|
||||
}
|
||||
|
|
@ -25,11 +25,13 @@ function.
|
|||
* Amazon AWS [Config options](https://github.com/hashicorp/go-discover/blob/master/provider/aws/aws_discover.go#L19-L33)
|
||||
* DigitalOcean [Config options](https://github.com/hashicorp/go-discover/blob/master/provider/digitalocean/digitalocean_discover.go#L16-L24)
|
||||
* Google Cloud [Config options](https://github.com/hashicorp/go-discover/blob/master/provider/gce/gce_discover.go#L17-L37)
|
||||
* Linode [Config options](https://github.com/hashicorp/go-discover/blob/master/provider/linode/linode_discover.go#L30-L41)
|
||||
* mDNS [Config options](https://github.com/hashicorp/go-discover/blob/master/provider/mdns/mdns_provider.go#L19-L31)
|
||||
* Microsoft Azure [Config options](https://github.com/hashicorp/go-discover/blob/master/provider/azure/azure_discover.go#L16-L37)
|
||||
* Openstack [Config options](https://github.com/hashicorp/go-discover/blob/master/provider/os/os_discover.go#L23-L38)
|
||||
* Scaleway [Config options](https://github.com/hashicorp/go-discover/blob/master/provider/scaleway/scaleway_discover.go#L14-L22)
|
||||
* SoftLayer [Config options](https://github.com/hashicorp/go-discover/blob/master/provider/softlayer/softlayer_discover.go#L16-L25)
|
||||
* TencentCloud [Config options](https://github.com/hashicorp/go-discover/blob/master/provider/tencentcloud/tencentcloud_discover.go#L23-L37)
|
||||
* Triton [Config options](https://github.com/hashicorp/go-discover/blob/master/provider/triton/triton_discover.go#L17-L27)
|
||||
* vSphere [Config options](https://github.com/hashicorp/go-discover/blob/master/provider/vsphere/vsphere_discover.go#L148-L155)
|
||||
* Packet [Config options](https://github.com/hashicorp/go-discover/blob/master/provider/packet/packet_discover.go#L25-L35)
|
||||
|
|
@ -59,6 +61,9 @@ provider=digitalocean region=... tag_name=... api_token=...
|
|||
# Google Cloud
|
||||
provider=gce project_name=... zone_pattern=eu-west-* tag_value=consul credentials_file=...
|
||||
|
||||
# Linode
|
||||
provider=linode tag_name=... region=us-east address_type=private_v4 api_token=...
|
||||
|
||||
# mDNS
|
||||
provider=mdns service=consul domain=local
|
||||
|
||||
|
|
@ -74,6 +79,9 @@ provider=scaleway organization=my-org tag_name=consul-server token=... region=..
|
|||
# SoftLayer
|
||||
provider=softlayer datacenter=dal06 tag_value=consul username=... api_key=...
|
||||
|
||||
# TencentCloud
|
||||
provider=tencentcloud region=ap-guangzhou tag_key=consul tag_value=... access_key_id=... access_key_secret=...
|
||||
|
||||
# Triton
|
||||
provider=triton account=testaccount url=https://us-sw-1.api.joyentcloud.com key_id=... tag_key=consul-role tag_value=server
|
||||
|
||||
|
|
|
|||
|
|
@ -14,11 +14,13 @@ import (
|
|||
"github.com/hashicorp/go-discover/provider/azure"
|
||||
"github.com/hashicorp/go-discover/provider/digitalocean"
|
||||
"github.com/hashicorp/go-discover/provider/gce"
|
||||
"github.com/hashicorp/go-discover/provider/linode"
|
||||
"github.com/hashicorp/go-discover/provider/mdns"
|
||||
"github.com/hashicorp/go-discover/provider/os"
|
||||
"github.com/hashicorp/go-discover/provider/packet"
|
||||
"github.com/hashicorp/go-discover/provider/scaleway"
|
||||
"github.com/hashicorp/go-discover/provider/softlayer"
|
||||
"github.com/hashicorp/go-discover/provider/tencentcloud"
|
||||
"github.com/hashicorp/go-discover/provider/triton"
|
||||
"github.com/hashicorp/go-discover/provider/vsphere"
|
||||
)
|
||||
|
|
@ -48,10 +50,12 @@ var Providers = map[string]Provider{
|
|||
"azure": &azure.Provider{},
|
||||
"digitalocean": &digitalocean.Provider{},
|
||||
"gce": &gce.Provider{},
|
||||
"linode": &linode.Provider{},
|
||||
"mdns": &mdns.Provider{},
|
||||
"os": &os.Provider{},
|
||||
"scaleway": &scaleway.Provider{},
|
||||
"softlayer": &softlayer.Provider{},
|
||||
"tencentcloud": &tencentcloud.Provider{},
|
||||
"triton": &triton.Provider{},
|
||||
"vsphere": &vsphere.Provider{},
|
||||
"packet": &packet.Provider{},
|
||||
|
|
|
|||
|
|
@ -5,11 +5,13 @@ require (
|
|||
github.com/Azure/azure-sdk-for-go v16.0.0+incompatible
|
||||
github.com/Azure/go-autorest v10.7.0+incompatible
|
||||
github.com/abdullin/seq v0.0.0-20160510034733-d5467c17e7af // indirect
|
||||
github.com/aws/aws-sdk-go v1.15.24
|
||||
github.com/aws/aws-sdk-go v1.25.41
|
||||
github.com/davecgh/go-spew v1.1.1 // indirect
|
||||
github.com/denverdino/aliyungo v0.0.0-20170926055100-d3308649c661
|
||||
github.com/dgrijalva/jwt-go v3.2.0+incompatible // indirect
|
||||
github.com/digitalocean/godo v1.1.1
|
||||
github.com/dimchansky/utfbom v1.1.0 // indirect
|
||||
github.com/dnaeon/go-vcr v1.0.1 // indirect
|
||||
github.com/fsnotify/fsnotify v1.4.7 // indirect
|
||||
github.com/ghodss/yaml v1.0.0 // indirect
|
||||
github.com/gogo/protobuf v1.1.1 // indirect
|
||||
|
|
@ -31,6 +33,8 @@ require (
|
|||
github.com/joyent/triton-go v0.0.0-20180628001255-830d2b111e62
|
||||
github.com/json-iterator/go v1.1.5 // indirect
|
||||
github.com/jtolds/gls v4.2.1+incompatible // indirect
|
||||
github.com/likexian/gokit v0.20.16
|
||||
github.com/linode/linodego v0.7.1
|
||||
github.com/mitchellh/go-homedir v1.0.0
|
||||
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
|
||||
github.com/modern-go/reflect2 v1.0.1 // indirect
|
||||
|
|
@ -49,6 +53,7 @@ require (
|
|||
github.com/softlayer/softlayer-go v0.0.0-20180806151055-260589d94c7d
|
||||
github.com/spf13/pflag v1.0.2 // indirect
|
||||
github.com/stretchr/testify v1.2.2 // indirect
|
||||
github.com/tencentcloud/tencentcloud-sdk-go v3.0.83+incompatible
|
||||
github.com/tent/http-link-go v0.0.0-20130702225549-ac974c61c2f9 // indirect
|
||||
github.com/vmware/govmomi v0.18.0
|
||||
golang.org/x/oauth2 v0.0.0-20170807180024-9a379c6b3e95
|
||||
|
|
@ -60,9 +65,11 @@ require (
|
|||
gopkg.in/fsnotify.v1 v1.4.7 // indirect
|
||||
gopkg.in/gemnasium/logrus-airbrake-hook.v2 v2.1.2 // indirect
|
||||
gopkg.in/inf.v0 v0.9.1 // indirect
|
||||
gopkg.in/resty.v1 v1.12.0 // indirect
|
||||
gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect
|
||||
gopkg.in/yaml.v2 v2.2.1 // indirect
|
||||
k8s.io/api v0.0.0-20180806132203-61b11ee65332
|
||||
k8s.io/apimachinery v0.0.0-20180821005732-488889b0007f
|
||||
k8s.io/client-go v8.0.0+incompatible
|
||||
launchpad.net/gocheck v0.0.0-20140225173054-000000000087 // indirect
|
||||
)
|
||||
|
|
|
|||
|
|
@ -8,6 +8,8 @@ github.com/abdullin/seq v0.0.0-20160510034733-d5467c17e7af h1:DBNMBMuMiWYu0b+8KM
|
|||
github.com/abdullin/seq v0.0.0-20160510034733-d5467c17e7af/go.mod h1:5Jv4cbFiHJMsVxt52+i0Ha45fjshj6wxYr1r19tB9bw=
|
||||
github.com/aws/aws-sdk-go v1.15.24 h1:xLAdTA/ore6xdPAljzZRed7IGqQgC+nY+ERS5vaj4Ro=
|
||||
github.com/aws/aws-sdk-go v1.15.24/go.mod h1:mFuSZ37Z9YOHbQEwBWztmVzqXrEkub65tZoCYDt7FT0=
|
||||
github.com/aws/aws-sdk-go v1.25.41 h1:/hj7nZ0586wFqpwjNpzWiUTwtaMgxAZNZKHay80MdXw=
|
||||
github.com/aws/aws-sdk-go v1.25.41/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo=
|
||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/denverdino/aliyungo v0.0.0-20170926055100-d3308649c661 h1:lrWnAyy/F72MbxIxFUzKmcMCdt9Oi8RzpAxzTNQHD7o=
|
||||
|
|
@ -16,6 +18,10 @@ github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumC
|
|||
github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
|
||||
github.com/digitalocean/godo v1.1.1 h1:v0A7yF3xmKLjjdJGIeBbINfMufcrrRhqZsxuVQMoT+U=
|
||||
github.com/digitalocean/godo v1.1.1/go.mod h1:h6faOIcZ8lWIwNQ+DN7b3CgX4Kwby5T+nbpNqkUIozU=
|
||||
github.com/dimchansky/utfbom v1.1.0 h1:FcM3g+nofKgUteL8dm/UpdRXNC9KmADgTpLKsu0TRo4=
|
||||
github.com/dimchansky/utfbom v1.1.0/go.mod h1:rO41eb7gLfo8SF1jd9F8HplJm1Fewwi4mQvIirEdv+8=
|
||||
github.com/dnaeon/go-vcr v1.0.1 h1:r8L/HqC0Hje5AXMu1ooW8oyQyOFv4GxqpL0nRP7SLLY=
|
||||
github.com/dnaeon/go-vcr v1.0.1/go.mod h1:aBB1+wY4s93YsC3HHjMBMrwTj2R9FHDzUr9KyGc8n1E=
|
||||
github.com/fsnotify/fsnotify v1.4.7 h1:IXs+QLmnXW2CcXuY+8Mzv/fWEsPGWxqefPtCP5CnV9I=
|
||||
github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
|
||||
github.com/ghodss/yaml v1.0.0 h1:wQHKEahhL6wmXdzwWG11gIVCkOv05bNOh+Rxn0yngAk=
|
||||
|
|
@ -66,6 +72,16 @@ github.com/json-iterator/go v1.1.5 h1:gL2yXlmiIo4+t+y32d4WGwOjKGYcGOuyrg46vadswD
|
|||
github.com/json-iterator/go v1.1.5/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU=
|
||||
github.com/jtolds/gls v4.2.1+incompatible h1:fSuqC+Gmlu6l/ZYAoZzx2pyucC8Xza35fpRVWLVmUEE=
|
||||
github.com/jtolds/gls v4.2.1+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU=
|
||||
github.com/likexian/gokit v0.0.0-20190309162924-0a377eecf7aa/go.mod h1:QdfYv6y6qPA9pbBA2qXtoT8BMKha6UyNbxWGWl/9Jfk=
|
||||
github.com/likexian/gokit v0.0.0-20190418170008-ace88ad0983b/go.mod h1:KKqSnk/VVSW8kEyO2vVCXoanzEutKdlBAPohmGXkxCk=
|
||||
github.com/likexian/gokit v0.0.0-20190501133040-e77ea8b19cdc/go.mod h1:3kvONayqCaj+UgrRZGpgfXzHdMYCAO0KAt4/8n0L57Y=
|
||||
github.com/likexian/gokit v0.20.16 h1:8ypmVXLx8yIvlTwzH8Ybz8LDAfWjdy0W5O354JWPjA4=
|
||||
github.com/likexian/gokit v0.20.16/go.mod h1:kn+nTv3tqh6yhor9BC4Lfiu58SmH8NmQ2PmEl+uM6nU=
|
||||
github.com/likexian/simplejson-go v0.0.0-20190409170913-40473a74d76d/go.mod h1:Typ1BfnATYtZ/+/shXfFYLrovhFyuKvzwrdOnIDHlmg=
|
||||
github.com/likexian/simplejson-go v0.0.0-20190419151922-c1f9f0b4f084/go.mod h1:U4O1vIJvIKwbMZKUJ62lppfdvkCdVd2nfMimHK81eec=
|
||||
github.com/likexian/simplejson-go v0.0.0-20190502021454-d8787b4bfa0b/go.mod h1:3BWwtmKP9cXWwYCr5bkoVDEfLywacOv0s06OBEDpyt8=
|
||||
github.com/linode/linodego v0.7.1 h1:4WZmMpSA2NRwlPZcc0+4Gyn7rr99Evk9bnr0B3gXRKE=
|
||||
github.com/linode/linodego v0.7.1/go.mod h1:ga11n3ivecUrPCHN0rANxKmfWBJVkOXfLMZinAbj2sY=
|
||||
github.com/miekg/dns v1.0.14 h1:9jZdLNd/P4+SfEJ0TNyxYpsK8N4GtfylBLqtbYN1sbA=
|
||||
github.com/miekg/dns v1.0.14/go.mod h1:W1PPwlIAgtquWBMBEV9nkV9Cazfe8ScdGz/Lj7v3Nrg=
|
||||
github.com/mitchellh/go-homedir v1.0.0 h1:vKb8ShqSby24Yrqr/yDYkuFz8d0WUjys40rvnGC8aR0=
|
||||
|
|
@ -104,6 +120,8 @@ github.com/spf13/pflag v1.0.2 h1:Fy0orTDgHdbnzHcsOgfCN4LtHf0ec3wwtiwJqwvf3Gc=
|
|||
github.com/spf13/pflag v1.0.2/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
|
||||
github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
|
||||
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
|
||||
github.com/tencentcloud/tencentcloud-sdk-go v3.0.83+incompatible h1:8uRvJleFpqLsO77WaAh2UrasMOzd8MxXrNj20e7El+Q=
|
||||
github.com/tencentcloud/tencentcloud-sdk-go v3.0.83+incompatible/go.mod h1:0PfYow01SHPMhKY31xa+EFz2RStxIqj6JFAJS+IkCi4=
|
||||
github.com/tent/http-link-go v0.0.0-20130702225549-ac974c61c2f9 h1:/Bsw4C+DEdqPjt8vAqaC9LAqpAQnaCQQqmolqq3S1T4=
|
||||
github.com/tent/http-link-go v0.0.0-20130702225549-ac974c61c2f9/go.mod h1:RHkNRtSLfOK7qBTHaeSX1D6BNpI3qw7NTxsmNr4RvN8=
|
||||
github.com/vmware/govmomi v0.18.0 h1:f7QxSmP7meCtoAmiKZogvVbLInT+CZx6Px6K5rYsJZo=
|
||||
|
|
@ -112,6 +130,8 @@ golang.org/x/crypto v0.0.0-20181029021203-45a5f77698d3 h1:KYQXGkl6vs02hK7pK4eIbw
|
|||
golang.org/x/crypto v0.0.0-20181029021203-45a5f77698d3/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
|
||||
golang.org/x/net v0.0.0-20181023162649-9b4f9f5ad519 h1:x6rhz8Y9CjbgQkccRGmELH6K+LJj7tOoh3XWeC1yaQM=
|
||||
golang.org/x/net v0.0.0-20181023162649-9b4f9f5ad519/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
golang.org/x/net v0.0.0-20181220203305-927f97764cc3 h1:eH6Eip3UpmR+yM/qI9Ijluzb1bNv/cAU/n+6l8tRSis=
|
||||
golang.org/x/net v0.0.0-20181220203305-927f97764cc3/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
golang.org/x/oauth2 v0.0.0-20170807180024-9a379c6b3e95 h1:RS+wSrhdVci7CsPwJaMN8exaP3UTuQU0qB34R/E/JD0=
|
||||
golang.org/x/oauth2 v0.0.0-20170807180024-9a379c6b3e95/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
|
||||
golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4 h1:YUO/7uOKsKeq9UokNS62b8FYywz3ker1l1vDZRCRefw=
|
||||
|
|
@ -136,6 +156,8 @@ gopkg.in/gemnasium/logrus-airbrake-hook.v2 v2.1.2 h1:OAj3g0cR6Dx/R07QgQe8wkA9RNj
|
|||
gopkg.in/gemnasium/logrus-airbrake-hook.v2 v2.1.2/go.mod h1:Xk6kEKp8OKb+X14hQBKWaSkCsqBpgog8nAV2xsGOxlo=
|
||||
gopkg.in/inf.v0 v0.9.1 h1:73M5CoZyi3ZLMOyDlQh031Cx6N9NDJ2Vvfl76EDAgDc=
|
||||
gopkg.in/inf.v0 v0.9.1/go.mod h1:cWUDdTG/fYaXco+Dcufb5Vnc6Gp2YChqWtbxRZE0mXw=
|
||||
gopkg.in/resty.v1 v1.12.0 h1:CuXP0Pjfw9rOuY6EP+UvtNvt5DSqHpIxILZKT/quCZI=
|
||||
gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo=
|
||||
gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ=
|
||||
gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw=
|
||||
gopkg.in/yaml.v2 v2.2.1 h1:mUhvW9EsL+naU5Q3cakzfE91YhliOondGd6ZrsDBHQE=
|
||||
|
|
@ -146,3 +168,5 @@ k8s.io/apimachinery v0.0.0-20180821005732-488889b0007f h1:V0PkbgaYp5JqCmzLyRmssD
|
|||
k8s.io/apimachinery v0.0.0-20180821005732-488889b0007f/go.mod h1:ccL7Eh7zubPUSh9A3USN90/OzHNSVN6zxzde07TDCL0=
|
||||
k8s.io/client-go v8.0.0+incompatible h1:tTI4hRmb1DRMl4fG6Vclfdi6nTM82oIrTT7HfitmxC4=
|
||||
k8s.io/client-go v8.0.0+incompatible/go.mod h1:7vJpHMYJwNQCWgzmNV+VYUl1zCObLyodBc8nIyt8L5s=
|
||||
launchpad.net/gocheck v0.0.0-20140225173054-000000000087 h1:Izowp2XBH6Ya6rv+hqbceQyw/gSGoXfH/UPoTGduL54=
|
||||
launchpad.net/gocheck v0.0.0-20140225173054-000000000087/go.mod h1:hj7XX3B/0A+80Vse0e+BUHsHMTEhd0O4cpUHr/e/BUM=
|
||||
|
|
|
|||
|
|
@ -10,8 +10,7 @@ import (
|
|||
|
||||
"github.com/Azure/azure-sdk-for-go/services/network/mgmt/2015-06-15/network"
|
||||
"github.com/Azure/go-autorest/autorest"
|
||||
"github.com/Azure/go-autorest/autorest/adal"
|
||||
"github.com/Azure/go-autorest/autorest/azure"
|
||||
"github.com/Azure/go-autorest/autorest/azure/auth"
|
||||
)
|
||||
|
||||
type Provider struct {
|
||||
|
|
@ -40,6 +39,10 @@ func (p *Provider) Help() string {
|
|||
export ARM_CLIENT_ID for client
|
||||
export ARM_CLIENT_SECRET for secret access key
|
||||
|
||||
If none of those options are given, the Azure SDK is using the default environment based authentication outlined
|
||||
here https://docs.microsoft.com/en-us/go/azure/azure-sdk-go-authorization#use-environment-based-authentication
|
||||
This will fallback to MSI if nothing is explicitly specified.
|
||||
|
||||
Use these configuration parameters when using tags:
|
||||
|
||||
tag_name: The name of the tag to filter on
|
||||
|
|
@ -60,13 +63,15 @@ func (p *Provider) Help() string {
|
|||
|
||||
// argsOrEnv allows you to pick an environmental variable for a setting if the arg is not set
|
||||
func argsOrEnv(args map[string]string, key, env string) string {
|
||||
if value, ok := args[key]; ok {
|
||||
return value
|
||||
}
|
||||
return os.Getenv(env)
|
||||
if value, ok := args[key]; ok {
|
||||
return value
|
||||
}
|
||||
return os.Getenv(env)
|
||||
}
|
||||
|
||||
func (p *Provider) Addrs(args map[string]string, l *log.Logger) ([]string, error) {
|
||||
var authorizer autorest.Authorizer
|
||||
|
||||
if args["provider"] != "azure" {
|
||||
return nil, fmt.Errorf("discover-azure: invalid provider " + args["provider"])
|
||||
}
|
||||
|
|
@ -81,6 +86,22 @@ func (p *Provider) Addrs(args map[string]string, l *log.Logger) ([]string, error
|
|||
subscriptionID := argsOrEnv(args, "subscription_id", "ARM_SUBSCRIPTION_ID")
|
||||
secretKey := argsOrEnv(args, "secret_access_key", "ARM_CLIENT_SECRET")
|
||||
|
||||
// Try to use the argument and environment provided arguments first, if this fails fall back to the Azure
|
||||
// SDK provided methods
|
||||
if tenantID != "" && clientID != "" && secretKey != "" {
|
||||
var err error
|
||||
authorizer, err = auth.NewClientCredentialsConfig(clientID, secretKey, tenantID).Authorizer()
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("discover-azure (ClientCredentials): %s", err)
|
||||
}
|
||||
} else {
|
||||
var err error
|
||||
authorizer, err = auth.NewAuthorizerFromEnvironment()
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("discover-azure (EnvironmentCredentials): %s", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Use tags if using network interfaces
|
||||
tagName := args["tag_name"]
|
||||
tagValue := args["tag_value"]
|
||||
|
|
@ -89,22 +110,10 @@ func (p *Provider) Addrs(args map[string]string, l *log.Logger) ([]string, error
|
|||
resourceGroup := args["resource_group"]
|
||||
vmScaleSet := args["vm_scale_set"]
|
||||
|
||||
// Only works for the Azure PublicCLoud for now; no ability to test other Environment
|
||||
oauthConfig, err := adal.NewOAuthConfig(azure.PublicCloud.ActiveDirectoryEndpoint, tenantID)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("discover-azure: %s", err)
|
||||
}
|
||||
|
||||
// Get the ServicePrincipalToken for use searching the NetworkInterfaces
|
||||
sbt, err := adal.NewServicePrincipalToken(*oauthConfig, clientID, secretKey, azure.PublicCloud.ResourceManagerEndpoint)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("discover-azure: %s", err)
|
||||
}
|
||||
|
||||
// Setup the client using autorest; followed the structure from Terraform
|
||||
vmnet := network.NewInterfacesClient(subscriptionID)
|
||||
vmnet.Sender = autorest.CreateSender(autorest.WithLogging(l))
|
||||
vmnet.Authorizer = autorest.NewBearerAuthorizer(sbt)
|
||||
vmnet.Authorizer = authorizer
|
||||
|
||||
if p.userAgent != "" {
|
||||
vmnet.Client.UserAgent = p.userAgent
|
||||
|
|
|
|||
142
vendor/github.com/hashicorp/go-discover/provider/linode/linode_discover.go
generated
vendored
Normal file
142
vendor/github.com/hashicorp/go-discover/provider/linode/linode_discover.go
generated
vendored
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
// Package linode provides node discovery for Linode.
|
||||
package linode
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"log"
|
||||
"net/http"
|
||||
"os"
|
||||
|
||||
"github.com/linode/linodego"
|
||||
"golang.org/x/oauth2"
|
||||
)
|
||||
|
||||
type Filter struct {
|
||||
Region string `json:"region,omitempty"`
|
||||
Tag string `json:"tags,omitempty"`
|
||||
}
|
||||
|
||||
type Provider struct {
|
||||
userAgent string
|
||||
}
|
||||
|
||||
func (p *Provider) SetUserAgent(s string) {
|
||||
p.userAgent = s
|
||||
}
|
||||
|
||||
func (p *Provider) Help() string {
|
||||
return `Linode:
|
||||
provider: "linode"
|
||||
api_token: The Linode API token to use
|
||||
region: The Linode region to filter on
|
||||
tag_name: The tag name to filter on
|
||||
address_type: "private_v4", "public_v4", "private_v6" or "public_v6". (default: "private_v4")
|
||||
|
||||
Variables can also be provided by environment variables:
|
||||
export LINODE_TOKEN for api_token
|
||||
`
|
||||
}
|
||||
|
||||
func (p *Provider) Addrs(args map[string]string, l *log.Logger) ([]string, error) {
|
||||
if args["provider"] != "linode" {
|
||||
return nil, fmt.Errorf("discover-linode: invalid provider " + args["provider"])
|
||||
}
|
||||
|
||||
if l == nil {
|
||||
l = log.New(ioutil.Discard, "", 0)
|
||||
}
|
||||
|
||||
addressType := args["address_type"]
|
||||
region := args["region"]
|
||||
tagName := args["tag_name"]
|
||||
apiToken := argsOrEnv(args, "api_token", "LINODE_TOKEN")
|
||||
l.Printf("[DEBUG] discover-linode: Using address_type=%s region=%s tag_name=%s", addressType, region, tagName)
|
||||
|
||||
client := getLinodeClient(p.userAgent, apiToken)
|
||||
|
||||
filters := Filter{
|
||||
Region: "",
|
||||
Tag: "",
|
||||
}
|
||||
|
||||
if region != "" {
|
||||
filters.Region = region
|
||||
}
|
||||
if tagName != "" {
|
||||
filters.Tag = tagName
|
||||
}
|
||||
|
||||
jsonFilters, _ := json.Marshal(filters)
|
||||
filterOpt := linodego.ListOptions{Filter: string(jsonFilters)}
|
||||
|
||||
linodes, err := client.ListInstances(context.Background(), &filterOpt)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("discover-linode: Fetching Linode instances failed: %s", err)
|
||||
}
|
||||
|
||||
var addrs []string
|
||||
for _, linode := range linodes {
|
||||
addr, err := client.GetInstanceIPAddresses(context.Background(), linode.ID)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("discover-linode: Fetching Linode IP address for instance %v failed: %s", linode.ID, err)
|
||||
}
|
||||
|
||||
switch addressType {
|
||||
case "public_v4":
|
||||
if len(addr.IPv4.Public) == 0 {
|
||||
break
|
||||
}
|
||||
addrs = append(addrs, addr.IPv4.Public[0].Address)
|
||||
case "private_v4":
|
||||
if len(addr.IPv4.Private) == 0 {
|
||||
break
|
||||
}
|
||||
addrs = append(addrs, addr.IPv4.Private[0].Address)
|
||||
case "public_v6":
|
||||
if addr.IPv6.SLAAC.Address == "" {
|
||||
break
|
||||
}
|
||||
addrs = append(addrs, addr.IPv6.SLAAC.Address)
|
||||
case "private_v6":
|
||||
if addr.IPv6.LinkLocal.Address == "" {
|
||||
break
|
||||
}
|
||||
addrs = append(addrs, addr.IPv6.LinkLocal.Address)
|
||||
default:
|
||||
if len(addr.IPv4.Private) == 0 {
|
||||
break
|
||||
}
|
||||
addrs = append(addrs, addr.IPv4.Private[0].Address)
|
||||
}
|
||||
}
|
||||
|
||||
return addrs, nil
|
||||
}
|
||||
|
||||
func getLinodeClient(userAgent, apiToken string) linodego.Client {
|
||||
tokenSource := oauth2.StaticTokenSource(&oauth2.Token{AccessToken: apiToken})
|
||||
|
||||
oauth2Client := &http.Client{
|
||||
Transport: &oauth2.Transport{
|
||||
Source: tokenSource,
|
||||
},
|
||||
}
|
||||
|
||||
client := linodego.NewClient(oauth2Client)
|
||||
|
||||
if userAgent != "" {
|
||||
client.SetUserAgent(userAgent)
|
||||
}
|
||||
|
||||
return client
|
||||
}
|
||||
|
||||
func argsOrEnv(args map[string]string, key, env string) string {
|
||||
if value := args[key]; value != "" {
|
||||
return value
|
||||
}
|
||||
return os.Getenv(env)
|
||||
}
|
||||
134
vendor/github.com/hashicorp/go-discover/provider/tencentcloud/tencentcloud_discover.go
generated
vendored
Normal file
134
vendor/github.com/hashicorp/go-discover/provider/tencentcloud/tencentcloud_discover.go
generated
vendored
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
// Package tencentcloud provides node discovery for TencentCloud.
|
||||
package tencentcloud
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"log"
|
||||
|
||||
"github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common"
|
||||
"github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile"
|
||||
cvm "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cvm/v20170312"
|
||||
)
|
||||
|
||||
type Provider struct {
|
||||
userAgent string
|
||||
}
|
||||
|
||||
func (p *Provider) SetUserAgent(s string) {
|
||||
p.userAgent = s
|
||||
}
|
||||
|
||||
func (p *Provider) Help() string {
|
||||
return `TencentCloud:
|
||||
|
||||
provider: "tencentcloud"
|
||||
region: The TencentCloud region
|
||||
tag_key: The tag key to filter on
|
||||
tag_value: The tag value to filter on
|
||||
address_type: "private_v4", "public_v4". (default: "private_v4")
|
||||
access_key_id: The secret id of TencentCloud
|
||||
access_key_secret: The secret key of TencentCloud
|
||||
|
||||
This required permission to 'cvm:DescribeInstances'.
|
||||
It is recommended you make a dedicated key used only for auto-joining.
|
||||
`
|
||||
}
|
||||
|
||||
func (p *Provider) Addrs(args map[string]string, l *log.Logger) ([]string, error) {
|
||||
if args["provider"] != "tencentcloud" {
|
||||
return nil, fmt.Errorf("discover-tencentcloud: invalid provider " + args["provider"])
|
||||
}
|
||||
|
||||
if l == nil {
|
||||
l = log.New(ioutil.Discard, "", 0)
|
||||
}
|
||||
|
||||
region := args["region"]
|
||||
tagKey := args["tag_key"]
|
||||
tagValue := args["tag_value"]
|
||||
addressType := args["address_type"]
|
||||
accessKeyID := args["access_key_id"]
|
||||
accessKeySecret := args["access_key_secret"]
|
||||
|
||||
l.Printf("[DEBUG] discover-tencentcloud: Using region=%s, tag_key=%s, tag_value=%s", region, tagKey, tagValue)
|
||||
if accessKeyID == "" {
|
||||
l.Printf("[DEBUG] discover-tencentcloud: No static credentials provided")
|
||||
} else {
|
||||
l.Printf("[DEBUG] discover-tencentcloud: Static credentials provided")
|
||||
}
|
||||
|
||||
if region == "" {
|
||||
l.Printf("[DEBUG] discover-tencentcloud: Region not provided")
|
||||
return nil, fmt.Errorf("discover-tencentcloud: region missing")
|
||||
}
|
||||
l.Printf("[DEBUG] discover-tencentcloud: region is %s", region)
|
||||
|
||||
if addressType == "" {
|
||||
addressType = "private_v4"
|
||||
}
|
||||
|
||||
if addressType != "private_v4" && addressType != "public_v4" {
|
||||
l.Printf("[DEBUG] discover-tencentcloud: Address type %s invalid", addressType)
|
||||
return nil, fmt.Errorf("discover-tencentcloud: invalid address_type " + addressType)
|
||||
}
|
||||
l.Printf("[DEBUG] discover-tencentcloud: address type is %s", addressType)
|
||||
|
||||
credential := common.NewCredential(
|
||||
accessKeyID,
|
||||
accessKeySecret,
|
||||
)
|
||||
|
||||
cpf := profile.NewClientProfile()
|
||||
cpf.HttpProfile.ReqMethod = "POST"
|
||||
cpf.HttpProfile.ReqTimeout = 300
|
||||
cpf.Language = "en-US"
|
||||
cvmClient, _ := cvm.NewClient(credential, region, cpf)
|
||||
|
||||
l.Printf("[DEBUG] discover-tencentcloud: Filter instances with %s=%s", tagKey, tagValue)
|
||||
request := cvm.NewDescribeInstancesRequest()
|
||||
request.Filters = []*cvm.Filter{
|
||||
{
|
||||
Name: stringToPointer("instance-state"),
|
||||
Values: []*string{stringToPointer("RUNNING")},
|
||||
},
|
||||
{
|
||||
Name: stringToPointer("tag:" + tagKey),
|
||||
Values: []*string{stringToPointer(tagValue)},
|
||||
},
|
||||
}
|
||||
|
||||
response, err := cvmClient.DescribeInstances(request)
|
||||
if err != nil {
|
||||
l.Printf("[DEBUG] discover-tencentcloud: DescribeInstances failed, %s", err)
|
||||
return nil, fmt.Errorf("discover-tencentcloud: DescribeInstances failed, %s", err)
|
||||
}
|
||||
l.Printf("[DEBUG] discover-tencentcloud: Found %d instances", len(response.Response.InstanceSet))
|
||||
|
||||
var addrs []string
|
||||
for _, v := range response.Response.InstanceSet {
|
||||
switch addressType {
|
||||
case "public_v4":
|
||||
if len(v.PublicIpAddresses) == 0 {
|
||||
l.Printf("[DEBUG] discover-tencentcloud: Instance %s has no public_v4", *v.InstanceId)
|
||||
continue
|
||||
}
|
||||
l.Printf("[DEBUG] discover-tencentcloud: Instance %s has public_v4 %v", *v.InstanceId, *v.PublicIpAddresses[0])
|
||||
addrs = append(addrs, *v.PublicIpAddresses[0])
|
||||
case "private_v4":
|
||||
if len(v.PrivateIpAddresses) == 0 {
|
||||
l.Printf("[DEBUG] discover-tencentcloud: Instance %s has no private_v4", *v.InstanceId)
|
||||
continue
|
||||
}
|
||||
l.Printf("[DEBUG] discover-tencentcloud: Instance %s has private_v4 %v", *v.InstanceId, *v.PrivateIpAddresses[0])
|
||||
addrs = append(addrs, *v.PrivateIpAddresses[0])
|
||||
}
|
||||
}
|
||||
|
||||
l.Printf("[DEBUG] discover-tencentcloud: Found address: %v", addrs)
|
||||
return addrs, nil
|
||||
}
|
||||
|
||||
func stringToPointer(s string) *string {
|
||||
return &s
|
||||
}
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# Binaries for programs and plugins
|
||||
*.exe
|
||||
*.dll
|
||||
*.so
|
||||
*.dylib
|
||||
|
||||
# Test binary, build with `go test -c`
|
||||
*.test
|
||||
|
||||
# Output of the go coverage tool, specifically when used with LiteIDE
|
||||
*.out
|
||||
|
||||
# Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736
|
||||
.glide/
|
||||
|
||||
vendor/**/
|
||||
.env
|
||||
coverage.txt
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
language: "go"
|
||||
|
||||
matrix:
|
||||
allow_failures:
|
||||
- go: tip
|
||||
|
||||
go:
|
||||
- "1.10"
|
||||
- tip
|
||||
|
||||
install:
|
||||
- go get -u gopkg.in/alecthomas/gometalinter.v2
|
||||
- gometalinter.v2 --install
|
||||
|
||||
script:
|
||||
- touch .env
|
||||
- make test ARGS='-v -race -count=2 -coverprofile=coverage.txt -covermode=atomic ./...'
|
||||
- gometalinter.v2 --enable-all --disable=vetshadow --disable=gocyclo --disable=unparam --disable=nakedret --disable=lll --disable=dupl --disable=gosec --disable=gochecknoinits --disable=gochecknoglobals --disable=test --deadline=120s
|
||||
- gometalinter.v2 --disable-all --enable=vetshadow --enable=gocyclo --enable=unparam --enable=nakedret --enable=lll --enable=dupl --enable=gosec --enable=gochecknoinits --enable=gochecknoglobals --deadline=120s || true
|
||||
|
||||
after_success:
|
||||
- bash <(curl -s https://codecov.io/bash)
|
||||
|
|
@ -0,0 +1,379 @@
|
|||
# API Support
|
||||
|
||||
## Linodes
|
||||
|
||||
- `/linode/instances`
|
||||
- [x] `GET`
|
||||
- [X] `POST`
|
||||
- `/linode/instances/$id`
|
||||
- [x] `GET`
|
||||
- [X] `PUT`
|
||||
- [X] `DELETE`
|
||||
- `/linode/instances/$id/boot`
|
||||
- [x] `POST`
|
||||
- `/linode/instances/$id/clone`
|
||||
- [x] `POST`
|
||||
- `/linode/instances/$id/mutate`
|
||||
- [X] `POST`
|
||||
- `/linode/instances/$id/reboot`
|
||||
- [x] `POST`
|
||||
- `/linode/instances/$id/rebuild`
|
||||
- [X] `POST`
|
||||
- `/linode/instances/$id/rescue`
|
||||
- [X] `POST`
|
||||
- `/linode/instances/$id/resize`
|
||||
- [x] `POST`
|
||||
- `/linode/instances/$id/shutdown`
|
||||
- [x] `POST`
|
||||
- `/linode/instances/$id/volumes`
|
||||
- [X] `GET`
|
||||
|
||||
### Backups
|
||||
|
||||
- `/linode/instances/$id/backups`
|
||||
- [X] `GET`
|
||||
- [ ] `POST`
|
||||
- `/linode/instances/$id/backups/$id/restore`
|
||||
- [ ] `POST`
|
||||
- `/linode/instances/$id/backups/cancel`
|
||||
- [ ] `POST`
|
||||
- `/linode/instances/$id/backups/enable`
|
||||
- [ ] `POST`
|
||||
|
||||
### Configs
|
||||
|
||||
- `/linode/instances/$id/configs`
|
||||
- [X] `GET`
|
||||
- [X] `POST`
|
||||
- `/linode/instances/$id/configs/$id`
|
||||
- [X] `GET`
|
||||
- [X] `PUT`
|
||||
- [X] `DELETE`
|
||||
|
||||
### Disks
|
||||
|
||||
- `/linode/instances/$id/disks`
|
||||
- [X] `GET`
|
||||
- [X] `POST`
|
||||
- `/linode/instances/$id/disks/$id`
|
||||
- [X] `GET`
|
||||
- [X] `PUT`
|
||||
- [X] `POST`
|
||||
- [X] `DELETE`
|
||||
- `/linode/instances/$id/disks/$id/password`
|
||||
- [X] `POST`
|
||||
- `/linode/instances/$id/disks/$id/resize`
|
||||
- [X] `POST`
|
||||
|
||||
### IPs
|
||||
|
||||
- `/linode/instances/$id/ips`
|
||||
- [ ] `GET`
|
||||
- [ ] `POST`
|
||||
- `/linode/instances/$id/ips/$ip_address`
|
||||
- [ ] `GET`
|
||||
- [ ] `PUT`
|
||||
- [ ] `DELETE`
|
||||
- `/linode/instances/$id/ips/sharing`
|
||||
- [ ] `POST`
|
||||
|
||||
### Kernels
|
||||
|
||||
- `/linode/kernels`
|
||||
- [X] `GET`
|
||||
- `/linode/kernels/$id`
|
||||
- [X] `GET`
|
||||
|
||||
### StackScripts
|
||||
|
||||
- `/linode/stackscripts`
|
||||
- [x] `GET`
|
||||
- [X] `POST`
|
||||
- `/linode/stackscripts/$id`
|
||||
- [x] `GET`
|
||||
- [X] `PUT`
|
||||
- [X] `DELETE`
|
||||
|
||||
### Stats
|
||||
|
||||
- `/linode/instances/$id/stats`
|
||||
- [ ] `GET`
|
||||
- `/linode/instances/$id/stats/$year/$month`
|
||||
- [ ] `GET`
|
||||
|
||||
### Types
|
||||
|
||||
- `/linode/types`
|
||||
- [X] `GET`
|
||||
- `/linode/types/$id`
|
||||
- [X] `GET`
|
||||
|
||||
## Domains
|
||||
|
||||
- `/domains`
|
||||
- [X] `GET`
|
||||
- [X] `POST`
|
||||
- `/domains/$id`
|
||||
- [X] `GET`
|
||||
- [X] `PUT`
|
||||
- [X] `DELETE`
|
||||
- `/domains/$id/clone`
|
||||
- [ ] `POST`
|
||||
- `/domains/$id/records`
|
||||
- [X] `GET`
|
||||
- [X] `POST`
|
||||
- `/domains/$id/records/$id`
|
||||
- [X] `GET`
|
||||
- [X] `PUT`
|
||||
- [X] `DELETE`
|
||||
|
||||
## Longview
|
||||
|
||||
- `/longview/clients`
|
||||
- [X] `GET`
|
||||
- [ ] `POST`
|
||||
- `/longview/clients/$id`
|
||||
- [X] `GET`
|
||||
- [ ] `PUT`
|
||||
- [ ] `DELETE`
|
||||
|
||||
### Subscriptions
|
||||
|
||||
- `/longview/subscriptions`
|
||||
- [ ] `GET`
|
||||
- `/longview/subscriptions/$id`
|
||||
- [ ] `GET`
|
||||
|
||||
### NodeBalancers
|
||||
|
||||
- `/nodebalancers`
|
||||
- [X] `GET`
|
||||
- [X] `POST`
|
||||
- `/nodebalancers/$id`
|
||||
- [X] `GET`
|
||||
- [X] `PUT`
|
||||
- [X] `DELETE`
|
||||
|
||||
### NodeBalancer Configs
|
||||
|
||||
- `/nodebalancers/$id/configs`
|
||||
- [X] `GET`
|
||||
- [X] `POST`
|
||||
- `/nodebalancers/$id/configs/$id`
|
||||
- [X] `GET`
|
||||
- [X] `DELETE`
|
||||
- `/nodebalancers/$id/configs/$id/nodes`
|
||||
- [X] `GET`
|
||||
- [X] `POST`
|
||||
- `/nodebalancers/$id/configs/$id/nodes/$id`
|
||||
- [X] `GET`
|
||||
- [X] `PUT`
|
||||
- [X] `DELETE`
|
||||
- `/nodebalancers/$id/configs/$id/rebuild`
|
||||
- [X] `POST`
|
||||
|
||||
## Networking
|
||||
|
||||
- `/networking/ip-assign`
|
||||
- [ ] `POST`
|
||||
- `/networking/ips`
|
||||
- [X] `GET`
|
||||
- [ ] `POST`
|
||||
- `/networking/ips/$address`
|
||||
- [X] `GET`
|
||||
- [ ] `PUT`
|
||||
- [ ] `DELETE`
|
||||
|
||||
### IPv6
|
||||
|
||||
- `/networking/ips`
|
||||
- [X] `GET`
|
||||
- `/networking/ips/$address`
|
||||
- [X] `GET`
|
||||
- [ ] `PUT`
|
||||
- /networking/ipv6/ranges
|
||||
- [X] `GET`
|
||||
- /networking/ipv6/pools
|
||||
- [X] `GET`
|
||||
|
||||
## Regions
|
||||
|
||||
- `/regions`
|
||||
- [x] `GET`
|
||||
- `/regions/$id`
|
||||
- [x] `GET`
|
||||
|
||||
## Support
|
||||
|
||||
- `/support/tickets`
|
||||
- [X] `GET`
|
||||
- [ ] `POST`
|
||||
- `/support/tickets/$id`
|
||||
- [X] `GET`
|
||||
- `/support/tickets/$id/attachments`
|
||||
- [ ] `POST`
|
||||
- `/support/tickets/$id/replies`
|
||||
- [ ] `GET`
|
||||
- [ ] `POST`
|
||||
|
||||
## Tags
|
||||
|
||||
- `/tags/`
|
||||
- [X] `GET`
|
||||
- [X] `POST`
|
||||
- `/tags/$id`
|
||||
- [X] `GET`
|
||||
- [X] `DELETE`
|
||||
|
||||
## Account
|
||||
|
||||
### Events
|
||||
|
||||
- `/account/events`
|
||||
- [X] `GET`
|
||||
- `/account/events/$id`
|
||||
- [X] `GET`
|
||||
- `/account/events/$id/read`
|
||||
- [X] `POST`
|
||||
- `/account/events/$id/seen`
|
||||
- [X] `POST`
|
||||
|
||||
### Invoices
|
||||
|
||||
- `/account/invoices/`
|
||||
- [X] `GET`
|
||||
- `/account/invoices/$id`
|
||||
- [X] `GET`
|
||||
- `/account/invoices/$id/items`
|
||||
- [X] `GET`
|
||||
|
||||
### Notifications
|
||||
|
||||
- `/account/notifications`
|
||||
- [X] `GET`
|
||||
|
||||
### OAuth Clients
|
||||
|
||||
- `/account/oauth-clients`
|
||||
- [ ] `GET`
|
||||
- [ ] `POST`
|
||||
- `/account/oauth-clients/$id`
|
||||
- [ ] `GET`
|
||||
- [ ] `PUT`
|
||||
- [ ] `DELETE`
|
||||
- `/account/oauth-clients/$id/reset_secret`
|
||||
- [ ] `POST`
|
||||
- `/account/oauth-clients/$id/thumbnail`
|
||||
- [ ] `GET`
|
||||
- [ ] `PUT`
|
||||
|
||||
### Payments
|
||||
|
||||
- `/account/payments`
|
||||
- [ ] `GET`
|
||||
- [ ] `POST`
|
||||
- `/account/payments/$id`
|
||||
- [ ] `GET`
|
||||
- `/account/payments/paypal`
|
||||
- [ ] `GET`
|
||||
- `/account/payments/paypal/execute`
|
||||
- [ ] `POST`
|
||||
|
||||
### Settings
|
||||
|
||||
- `/account/settings`
|
||||
- [ ] `GET`
|
||||
- [ ] `PUT`
|
||||
|
||||
### Users
|
||||
|
||||
- `/account/users`
|
||||
- [X] `GET`
|
||||
- [X] `POST`
|
||||
- `/account/users/$username`
|
||||
- [X] `GET`
|
||||
- [X] `PUT`
|
||||
- [X] `DELETE`
|
||||
- `/account/users/$username/grants`
|
||||
- [ ] `GET`
|
||||
- [ ] `PUT`
|
||||
- `/account/users/$username/password`
|
||||
- [ ] `POST`
|
||||
|
||||
## Profile
|
||||
|
||||
### Personalized User Settings
|
||||
|
||||
- `/profile`
|
||||
- [X] `GET`
|
||||
- [X] `PUT`
|
||||
|
||||
### Granted OAuth Apps
|
||||
|
||||
- `/profile/apps`
|
||||
- [ ] `GET`
|
||||
- `/profile/apps/$id`
|
||||
- [ ] `GET`
|
||||
- [ ] `DELETE`
|
||||
|
||||
### Grants to Linode Resources
|
||||
|
||||
- `/profile/grants`
|
||||
- [ ] `GET`
|
||||
|
||||
### SSH Keys
|
||||
|
||||
- `/profile/sshkeys`
|
||||
- [x] `GET`
|
||||
- [x] `POST`
|
||||
- `/profile/sshkeys/$id`
|
||||
- [x] `GET`
|
||||
- [x] `PUT`
|
||||
- [x] `DELETE`
|
||||
|
||||
### Two-Factor
|
||||
|
||||
- `/profile/tfa-disable`
|
||||
- [ ] `POST`
|
||||
- `/profile/tfa-enable`
|
||||
- [ ] `POST`
|
||||
- `/profile/tfa-enable-confirm`
|
||||
- [ ] `POST`
|
||||
|
||||
### Personal Access API Tokens
|
||||
|
||||
- `/profile/tokens`
|
||||
- [X] `GET`
|
||||
- [X] `POST`
|
||||
- `/profile/tokens/$id`
|
||||
- [X] `GET`
|
||||
- [X] `PUT`
|
||||
- [X] `DELETE`
|
||||
|
||||
## Images
|
||||
|
||||
- `/images`
|
||||
- [x] `GET`
|
||||
- `/images/$id`
|
||||
- [x] `GET`
|
||||
- [X] `POST`
|
||||
- [X] `PUT`
|
||||
- [X] `DELETE`
|
||||
|
||||
## Volumes
|
||||
|
||||
- `/volumes`
|
||||
- [X] `GET`
|
||||
- [X] `POST`
|
||||
- `/volumes/$id`
|
||||
- [X] `GET`
|
||||
- [X] `PUT`
|
||||
- [X] `DELETE`
|
||||
- `/volumes/$id/attach`
|
||||
- [X] `POST`
|
||||
- `/volumes/$id/clone`
|
||||
- [X] `POST`
|
||||
- `/volumes/$id/detach`
|
||||
- [X] `POST`
|
||||
- `/volumes/$id/resize`
|
||||
- [X] `POST`
|
||||
|
|
@ -0,0 +1,239 @@
|
|||
# Change Log
|
||||
|
||||
## Unreleased
|
||||
|
||||
### Fixes
|
||||
|
||||
### Features
|
||||
|
||||
<a name-"v0.7.1"></a>
|
||||
|
||||
## [v0.7.1](https://github.com/linode/linodego/compare/v0.7.0..v0.7.1) (2018-02-05)
|
||||
|
||||
### Features
|
||||
|
||||
* add `ClassDedicated` constant (`dedicated`) for use in `LinodeType` `Class` values
|
||||
See the [Dedicated CPU Announcement](https://blog.linode.com/2019/02/05/introducing-linode-dedicated-cpu-instances/)
|
||||
|
||||
<a name-"v0.7.0"></a>
|
||||
|
||||
## [v0.7.0](https://github.com/linode/linodego/compare/v0.6.2..v0.7.0) (2018-12-03)
|
||||
|
||||
### Features
|
||||
|
||||
* add `Tags` field in: `NodeBalancer`, `Domain`, `Volume`
|
||||
* add `UpdateIPAddress` (for setting RDNS)
|
||||
|
||||
### Fixes
|
||||
|
||||
* invalid URL for `/v4/networking/` enpoints (IPv6 Ranges and Pools) has been correcrted
|
||||
|
||||
<a name-"v0.6.2"></a>
|
||||
|
||||
## [v0.6.2](https://github.com/linode/linodego/compare/v0.6.1..v0.6.2) (2018-10-26)
|
||||
|
||||
### Fixes
|
||||
|
||||
* add missing `Account` fields: `address_1`, `address_2`, `phone`
|
||||
|
||||
<a name-"v0.6.1"></a>
|
||||
## [v0.6.1](https://github.com/linode/linodego/compare/v0.6.0..v0.6.1) (2018-10-26)
|
||||
|
||||
### Features
|
||||
|
||||
* Adds support for fetching and updating basic Profile information
|
||||
|
||||
<a name-"v0.6.0"></a>
|
||||
## [v0.6.0](https://github.com/linode/linodego/compare/v0.5.1..v0.6.0) (2018-10-25)
|
||||
|
||||
### Fixes
|
||||
|
||||
* Fixes Image date handling
|
||||
* Fixes broken example code in README
|
||||
* Fixes WaitForEventFinished when encountering events without entity
|
||||
* Fixes ResizeInstanceDisk which was executing CloneInstanceDisk
|
||||
* Fixes go-resty import path to gopkg.in version for future go module support
|
||||
|
||||
### Features
|
||||
|
||||
* Adds support for user account operations
|
||||
* Adds support for profile tokens
|
||||
* Adds support for Tags
|
||||
* Adds PasswordResetInstanceDisk
|
||||
* Adds DiskStatus constants
|
||||
* Adds WaitForInstanceDiskStatus
|
||||
* Adds SetPollDelay for configuring poll duration
|
||||
|
||||
* Reduced polling time to millisecond granularity
|
||||
* Change polling default to 3s to avoid 429 conditions
|
||||
* Use poll delay in waitfor functions
|
||||
|
||||
<a name="v0.5.1"></a>
|
||||
## [v0.5.1](https://github.com/linode/linodego/compare/v0.5.0...v0.5.1) (2018-09-10)
|
||||
|
||||
### Fixes
|
||||
|
||||
* Domain.Status was not imported from API responses correctly
|
||||
|
||||
<a name="v0.5.0"></a>
|
||||
## [v0.5.0](https://github.com/linode/linodego/compare/v0.4.0...v0.5.0) (2018-09-09)
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
* List functions return slice of thing instead of slice of pointer to thing
|
||||
|
||||
### Feature
|
||||
|
||||
* add SSHKeys methods to client (also affects InstanceCreate, InstanceDiskCreate)
|
||||
* add RebuildNodeBalancerConfig (and CreateNodeBalancerConfig with Nodes)
|
||||
|
||||
### Fixes
|
||||
|
||||
* Event.TimeRemaining wouldn't parse all possible API value
|
||||
* Tests no longer rely on known/special instance and volume ids
|
||||
|
||||
<a name="0.4.0"></a>
|
||||
## [0.4.0](https://github.com/linode/linodego/compare/v0.3.0...0.4.0) (2018-08-27)
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
Replaces bool, error results with error results, for:
|
||||
|
||||
* instance\_snapshots.go: EnableInstanceBackups
|
||||
* instance\_snapshots.go: CancelInstanceBackups
|
||||
* instance\_snapshots.go: RestoreInstanceBackup
|
||||
* instances.go: BootInstance
|
||||
* instances.go: RebootInstance
|
||||
* instances.go: MutateInstance
|
||||
* instances.go: RescueInstance
|
||||
* instances.go: ResizeInstance
|
||||
* instances.go: ShutdownInstance
|
||||
* volumes.go: DetachVolume
|
||||
* volumes.go: ResizeVolume
|
||||
|
||||
|
||||
### Docs
|
||||
|
||||
* reword text about breaking changes until first tag
|
||||
|
||||
### Feat
|
||||
|
||||
* added MigrateInstance and InstanceResizing from 4.0.1-4.0.3 API Changelog
|
||||
* added gometalinter to travis builds
|
||||
* added missing function and type comments as reported by linting tools
|
||||
* supply json values for all fields, useful for mocking responses using linodego types
|
||||
* use context channels in WaitFor\* functions
|
||||
* add LinodeTypeClass type (enum)
|
||||
* add TicketStatus type (enum)
|
||||
* update template thing and add a test template
|
||||
|
||||
### Fix
|
||||
|
||||
* TransferQuota was TransferQuote (and not parsed from the api correctly)
|
||||
* stackscripts udf was not parsed correctly
|
||||
* add InstanceCreateOptions.PrivateIP
|
||||
* check the WaitFor timeout before sleeping to avoid extra sleep
|
||||
* various linting warnings and unhandled err results as reported by linting tools
|
||||
* fix GetStackscript 404 handling
|
||||
|
||||
|
||||
<a name="0.3.0"></a>
|
||||
|
||||
## [0.3.0](https://github.com/linode/linodego/compare/v0.2.0...0.3.0) (2018-08-15)
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
* WaitForVolumeLinodeID return fetch volume for consistency with out WaitFors
|
||||
* Moved linodego from chiefy to github.com/linode. Thanks [@chiefy](https://github.com/chiefy)!
|
||||
|
||||
<a name="v0.2.0"></a>
|
||||
|
||||
## [v0.2.0](https://github.com/linode/linodego/compare/v0.1.1...v0.2.0) (2018-08-11)
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
* WaitFor\* should be client methods
|
||||
*use `client.WaitFor...` rather than `linodego.WaitFor(..., client, ...)`*
|
||||
|
||||
* remove ListInstanceSnapshots (does not exist in the API)
|
||||
*this never worked, so shouldn't cause a problem*
|
||||
|
||||
* Changes UpdateOptions and CreateOptions and similar Options parameters to values instead of pointers
|
||||
*these were never optional and the function never updated any values in the Options structures*
|
||||
|
||||
* fixed various optional/zero Update and Create options
|
||||
*some values are now pointers, and vice-versa*
|
||||
|
||||
* Changes InstanceUpdateOptions to use pointers for optional fields Backups and Alerts
|
||||
* Changes InstanceClone's Disks and Configs to ints instead of strings
|
||||
|
||||
* using new enum string aliased types where appropriate
|
||||
*`InstanceSnapshotStatus`, `DiskFilesystem`, `NodeMode`*
|
||||
|
||||
### Feature
|
||||
|
||||
* add RescueInstance and RescueInstanceOptions
|
||||
* add CreateImage, UpdateImage, DeleteImage
|
||||
* add EnableInstanceBackups, CancelInstanceBackups, RestoreInstanceBackup
|
||||
* add WatchdogEnabled to InstanceUpdateOptions
|
||||
|
||||
### Fix
|
||||
|
||||
* return Volume from AttachVolume instead of bool
|
||||
* add more boilerplate to template.go
|
||||
* nodebalancers and domain records had no pagination support
|
||||
* NodeBalancer transfer stats are not int
|
||||
|
||||
### Tests
|
||||
|
||||
* add fixtures and tests for NodeBalancerNodes
|
||||
* fix nodebalancer tests to handle changes due to random labels
|
||||
* add tests for nodebalancers and nodebalancer configs
|
||||
* added tests for Backups flow
|
||||
* TestListInstanceBackups fixture is hand tweaked because repeated polled events
|
||||
appear to get the tests stuck
|
||||
|
||||
### Deps
|
||||
|
||||
* update all dependencies to latest
|
||||
|
||||
<a name="v0.1.1"></a>
|
||||
|
||||
## [v0.1.1](https://github.com/linode/linodego/compare/v0.0.1...v0.1.0) (2018-07-30)
|
||||
|
||||
Adds more Domain handling
|
||||
|
||||
### Fixed
|
||||
|
||||
* go-resty doesnt pass errors when content-type is not set
|
||||
* Domain, DomainRecords, tests and fixtures
|
||||
|
||||
### Added
|
||||
|
||||
* add CreateDomainRecord, UpdateDomainRecord, and DeleteDomainRecord
|
||||
|
||||
<a name="v0.1.0"></a>
|
||||
|
||||
## [v0.1.0](https://github.com/linode/linodego/compare/v0.0.1...v0.1.0) (2018-07-23)
|
||||
|
||||
Deals with NewClient and context for all http requests
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
* changed `NewClient(token, *http.RoundTripper)` to `NewClient(*http.Client)`
|
||||
* changed all `Client` `Get`, `List`, `Create`, `Update`, `Delete`, and `Wait` calls to take context as the first parameter
|
||||
|
||||
### Fixed
|
||||
|
||||
* fixed docs should now show Examples for more functions
|
||||
|
||||
### Added
|
||||
|
||||
* added `Client.SetBaseURL(url string)`
|
||||
|
||||
<a name="v0.0.1"></a>
|
||||
## v0.0.1 (2018-07-20)
|
||||
|
||||
### Changed
|
||||
|
||||
* Initial tagged release
|
||||
|
|
@ -0,0 +1,111 @@
|
|||
# This file is autogenerated, do not edit; changes may be undone by the next 'dep ensure'.
|
||||
|
||||
|
||||
[[projects]]
|
||||
branch = "master"
|
||||
digest = "1:6e1c13bc32e58ccb4afa1115a3ba4fc071d918ed897b40dfa323ffb3fcc6619d"
|
||||
name = "github.com/dnaeon/go-vcr"
|
||||
packages = [
|
||||
"cassette",
|
||||
"recorder",
|
||||
]
|
||||
pruneopts = "UT"
|
||||
revision = "aafff18a5cc28fa0b2f26baf6a14472cda9b54c6"
|
||||
|
||||
[[projects]]
|
||||
digest = "1:97df918963298c287643883209a2c3f642e6593379f97ab400c2a2e219ab647d"
|
||||
name = "github.com/golang/protobuf"
|
||||
packages = ["proto"]
|
||||
pruneopts = "UT"
|
||||
revision = "aa810b61a9c79d51363740d207bb46cf8e620ed5"
|
||||
version = "v1.2.0"
|
||||
|
||||
[[projects]]
|
||||
branch = "master"
|
||||
digest = "1:33b9d71d1dde2106309484a388eb7ba53cd1f67014e34a71f7b3dbc20bd186e5"
|
||||
name = "golang.org/x/net"
|
||||
packages = [
|
||||
"context",
|
||||
"context/ctxhttp",
|
||||
"idna",
|
||||
"publicsuffix",
|
||||
]
|
||||
pruneopts = "UT"
|
||||
revision = "8a410e7b638dca158bf9e766925842f6651ff828"
|
||||
|
||||
[[projects]]
|
||||
branch = "master"
|
||||
digest = "1:363b547c971a2b07474c598b6e9ebcb238d556d8a27f37b3895ad20cd50e7281"
|
||||
name = "golang.org/x/oauth2"
|
||||
packages = [
|
||||
".",
|
||||
"internal",
|
||||
]
|
||||
pruneopts = "UT"
|
||||
revision = "d2e6202438beef2727060aa7cabdd924d92ebfd9"
|
||||
|
||||
[[projects]]
|
||||
digest = "1:a2ab62866c75542dd18d2b069fec854577a20211d7c0ea6ae746072a1dccdd18"
|
||||
name = "golang.org/x/text"
|
||||
packages = [
|
||||
"collate",
|
||||
"collate/build",
|
||||
"internal/colltab",
|
||||
"internal/gen",
|
||||
"internal/tag",
|
||||
"internal/triegen",
|
||||
"internal/ucd",
|
||||
"language",
|
||||
"secure/bidirule",
|
||||
"transform",
|
||||
"unicode/bidi",
|
||||
"unicode/cldr",
|
||||
"unicode/norm",
|
||||
"unicode/rangetable",
|
||||
]
|
||||
pruneopts = "UT"
|
||||
revision = "f21a4dfb5e38f5895301dc265a8def02365cc3d0"
|
||||
version = "v0.3.0"
|
||||
|
||||
[[projects]]
|
||||
digest = "1:328b5e4f197d928c444a51a75385f4b978915c0e75521f0ad6a3db976c97a7d3"
|
||||
name = "google.golang.org/appengine"
|
||||
packages = [
|
||||
"internal",
|
||||
"internal/base",
|
||||
"internal/datastore",
|
||||
"internal/log",
|
||||
"internal/remote_api",
|
||||
"internal/urlfetch",
|
||||
"urlfetch",
|
||||
]
|
||||
pruneopts = "UT"
|
||||
revision = "b1f26356af11148e710935ed1ac8a7f5702c7612"
|
||||
version = "v1.1.0"
|
||||
|
||||
[[projects]]
|
||||
digest = "1:b7fc4c3fd91df516486f53cc86f4b55a0c815782dbe852c5a19cce8e6c577aac"
|
||||
name = "gopkg.in/resty.v1"
|
||||
packages = ["."]
|
||||
pruneopts = "UT"
|
||||
revision = "d4920dcf5b7689548a6db640278a9b35a5b48ec6"
|
||||
version = "v1.9.1"
|
||||
|
||||
[[projects]]
|
||||
digest = "1:342378ac4dcb378a5448dd723f0784ae519383532f5e70ade24132c4c8693202"
|
||||
name = "gopkg.in/yaml.v2"
|
||||
packages = ["."]
|
||||
pruneopts = "UT"
|
||||
revision = "5420a8b6744d3b0345ab293f6fcba19c978f1183"
|
||||
version = "v2.2.1"
|
||||
|
||||
[solve-meta]
|
||||
analyzer-name = "dep"
|
||||
analyzer-version = 1
|
||||
input-imports = [
|
||||
"github.com/dnaeon/go-vcr/recorder",
|
||||
"golang.org/x/oauth2",
|
||||
"gopkg.in/resty.v1",
|
||||
]
|
||||
solver-name = "gps-cdcl"
|
||||
solver-version = 1
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
# Gopkg.toml example
|
||||
#
|
||||
# Refer to https://golang.github.io/dep/docs/Gopkg.toml.html
|
||||
# for detailed Gopkg.toml documentation.
|
||||
#
|
||||
# required = ["github.com/user/thing/cmd/thing"]
|
||||
# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
|
||||
#
|
||||
# [[constraint]]
|
||||
# name = "github.com/user/project"
|
||||
# version = "1.0.0"
|
||||
#
|
||||
# [[constraint]]
|
||||
# name = "github.com/user/project2"
|
||||
# branch = "dev"
|
||||
# source = "github.com/myfork/project2"
|
||||
#
|
||||
# [[override]]
|
||||
# name = "github.com/x/y"
|
||||
# version = "2.4.0"
|
||||
#
|
||||
# [prune]
|
||||
# non-go = false
|
||||
# go-tests = true
|
||||
# unused-packages = true
|
||||
|
||||
[prune]
|
||||
go-tests = true
|
||||
unused-packages = true
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2017 Christopher "Chief" Najewicz
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
include .env
|
||||
|
||||
.PHONY: vendor example refresh-fixtures clean-fixtures
|
||||
|
||||
.PHONY: test
|
||||
test: vendor
|
||||
@LINODE_FIXTURE_MODE="play" \
|
||||
LINODE_TOKEN="awesometokenawesometokenawesometoken" \
|
||||
go test $(ARGS)
|
||||
|
||||
$(GOPATH)/bin/dep:
|
||||
@go get -u github.com/golang/dep/cmd/dep
|
||||
|
||||
vendor: $(GOPATH)/bin/dep
|
||||
@dep ensure
|
||||
|
||||
example:
|
||||
@go run example/main.go
|
||||
|
||||
clean-fixtures:
|
||||
@-rm fixtures/*.yaml
|
||||
|
||||
refresh-fixtures: clean-fixtures fixtures
|
||||
|
||||
.PHONY: fixtures
|
||||
fixtures:
|
||||
@echo "* Running fixtures"
|
||||
@LINODE_TOKEN=$(LINODE_TOKEN) \
|
||||
LINODE_FIXTURE_MODE="record" go test $(ARGS)
|
||||
@echo "* Santizing fixtures"
|
||||
@for yaml in fixtures/*yaml; do \
|
||||
sed -E -i "" -e "s/$(LINODE_TOKEN)/awesometokenawesometokenawesometoken/g" \
|
||||
-e 's/20[0-9]{2}-[01][0-9]-[0-3][0-9]T[0-2][0-9]:[0-9]{2}:[0-9]{2}/2018-01-02T03:04:05/g' \
|
||||
-e 's/nb-[0-9]{1,3}-[0-9]{1,3}-[0-9]{1,3}-[0-9]{1,3}\./nb-10-20-30-40./g' \
|
||||
-e 's/192\.168\.((1?[0-9][0-9]?|2[0-4][0-9]|25[0-5])\.)(1?[0-9][0-9]?|2[0-4][0-9]|25[0-5])/192.168.030.040/g' \
|
||||
-e '/^192\.168/!s/((1?[0-9][0-9]?|2[0-4][0-9]|25[0-5])\.){3}(1?[0-9][0-9]?|2[0-4][0-9]|25[0-5])/10.20.30.40/g' \
|
||||
-e 's/(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))/1234::5678/g' \
|
||||
$$yaml; \
|
||||
done
|
||||
|
||||
.PHONY: godoc
|
||||
godoc:
|
||||
@godoc -http=:6060
|
||||
|
|
@ -0,0 +1,178 @@
|
|||
# linodego
|
||||
|
||||
[](https://travis-ci.org/linode/linodego)
|
||||
[](https://godoc.org/github.com/linode/linodego)
|
||||
[](https://goreportcard.com/report/github.com/linode/linodego)
|
||||
[](https://codecov.io/gh/linode/linodego)
|
||||
|
||||
Go client for [Linode REST v4 API](https://developers.linode.com/api/v4)
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
go get -u github.com/linode/linodego
|
||||
```
|
||||
|
||||
## API Support
|
||||
|
||||
Check [API_SUPPORT.md](API_SUPPORT.md) for current support of the Linode `v4` API endpoints.
|
||||
|
||||
** Note: This project will change and break until we release a v1.0.0 tagged version. Breaking changes in v0.x.x will be denoted with a minor version bump (v0.2.4 -> v0.3.0) **
|
||||
|
||||
## Documentation
|
||||
|
||||
See [godoc](https://godoc.org/github.com/linode/linodego) for a complete reference.
|
||||
|
||||
The API generally follows the naming patterns prescribed in the [OpenAPIv3 document for Linode APIv4](https://developers.linode.com/api/v4).
|
||||
|
||||
Deviations in naming have been made to avoid using "Linode" and "Instance" redundantly or inconsistently.
|
||||
|
||||
A brief summary of the features offered in this API client are shown here.
|
||||
|
||||
## Examples
|
||||
|
||||
### General Usage
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"github.com/linode/linodego"
|
||||
"golang.org/x/oauth2"
|
||||
|
||||
"log"
|
||||
"net/http"
|
||||
"os"
|
||||
)
|
||||
|
||||
func main() {
|
||||
apiKey, ok := os.LookupEnv("LINODE_TOKEN")
|
||||
if !ok {
|
||||
log.Fatal("Could not find LINODE_TOKEN, please assert it is set.")
|
||||
}
|
||||
tokenSource := oauth2.StaticTokenSource(&oauth2.Token{AccessToken: apiKey})
|
||||
|
||||
oauth2Client := &http.Client{
|
||||
Transport: &oauth2.Transport{
|
||||
Source: tokenSource,
|
||||
},
|
||||
}
|
||||
|
||||
linodeClient := linodego.NewClient(oauth2Client)
|
||||
linodeClient.SetDebug(true)
|
||||
|
||||
res, err := linodeClient.GetInstance(context.Background(), 4090913)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
fmt.Printf("%v", res)
|
||||
}
|
||||
```
|
||||
|
||||
### Pagination
|
||||
|
||||
#### Auto-Pagination Requests
|
||||
|
||||
```go
|
||||
kernels, err := linodego.ListKernels(context.Background(), nil)
|
||||
// len(kernels) == 218
|
||||
```
|
||||
|
||||
Or, use a page value of "0":
|
||||
|
||||
```go
|
||||
opts := NewListOptions(0,"")
|
||||
kernels, err := linodego.ListKernels(context.Background(), opts)
|
||||
// len(kernels) == 218
|
||||
```
|
||||
|
||||
#### Single Page
|
||||
|
||||
```go
|
||||
opts := NewListOptions(2,"")
|
||||
// or opts := ListOptions{PageOptions: &PageOptions: {Page: 2 }}
|
||||
kernels, err := linodego.ListKernels(context.Background(), opts)
|
||||
// len(kernels) == 100
|
||||
```
|
||||
|
||||
ListOptions are supplied as a pointer because the Pages and Results
|
||||
values are set in the supplied ListOptions.
|
||||
|
||||
```go
|
||||
// opts.Results == 218
|
||||
```
|
||||
|
||||
#### Filtering
|
||||
|
||||
```go
|
||||
opts := ListOptions{Filter: "{\"mine\":true}"}
|
||||
// or opts := NewListOptions(0, "{\"mine\":true}")
|
||||
stackscripts, err := linodego.ListStackscripts(context.Background(), opts)
|
||||
```
|
||||
|
||||
### Error Handling
|
||||
|
||||
#### Getting Single Entities
|
||||
|
||||
```go
|
||||
linode, err := linodego.GetLinode(context.Background(), 555) // any Linode ID that does not exist or is not yours
|
||||
// linode == nil: true
|
||||
// err.Error() == "[404] Not Found"
|
||||
// err.Code == "404"
|
||||
// err.Message == "Not Found"
|
||||
```
|
||||
|
||||
#### Lists
|
||||
|
||||
For lists, the list is still returned as `[]`, but `err` works the same way as on the `Get` request.
|
||||
|
||||
```go
|
||||
linodes, err := linodego.ListLinodes(context.Background(), NewListOptions(0, "{\"foo\":bar}"))
|
||||
// linodes == []
|
||||
// err.Error() == "[400] [X-Filter] Cannot filter on foo"
|
||||
```
|
||||
|
||||
Otherwise sane requests beyond the last page do not trigger an error, just an empty result:
|
||||
|
||||
```go
|
||||
linodes, err := linodego.ListLinodes(context.Background(), NewListOptions(9999, ""))
|
||||
// linodes == []
|
||||
// err = nil
|
||||
```
|
||||
|
||||
### Writes
|
||||
|
||||
When performing a `POST` or `PUT` request, multiple field related errors will be returned as a single error, currently like:
|
||||
|
||||
```go
|
||||
// err.Error() == "[400] [field1] foo problem; [field2] bar problem; [field3] baz problem"
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
Run `make test` to run the unit tests. This is the same as running `go test` except that `make test` will
|
||||
execute the tests while playing back API response fixtures that were recorded during a previous development build.
|
||||
|
||||
`go test` can be used without the fixtures. Copy `env.sample` to `.env` and configure your persistent test
|
||||
settings, including an API token.
|
||||
|
||||
`go test -short` can be used to run live API tests that do not require an account token.
|
||||
|
||||
This will be simplified in future versions.
|
||||
|
||||
To update the test fixtures, run `make fixtures`. This will record the API responses into the `fixtures/` directory.
|
||||
Be careful about committing any sensitive account details. An attempt has been made to sanitize IP addresses and
|
||||
dates, but no automated sanitization will be performed against `fixtures/*Account*.yaml`, for example.
|
||||
|
||||
To prevent disrupting unaffected fixtures, target fixture generation like so: `make ARGS="-run TestListVolumes" fixtures`.
|
||||
|
||||
## Discussion / Help
|
||||
|
||||
Join us at [#linodego](https://gophers.slack.com/messages/CAG93EB2S) on the [gophers slack](https://gophers.slack.com)
|
||||
|
||||
## License
|
||||
|
||||
[MIT License](LICENSE)
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
package linodego
|
||||
|
||||
import "context"
|
||||
|
||||
// Account associated with the token in use
|
||||
type Account struct {
|
||||
FirstName string `json:"first_name"`
|
||||
LastName string `json:"last_name"`
|
||||
Email string `json:"email"`
|
||||
Company string `json:"company"`
|
||||
Address1 string `json:"address_1"`
|
||||
Address2 string `json:"address_2"`
|
||||
Balance float32 `json:"balance"`
|
||||
City string `json:"city"`
|
||||
State string `json:"state"`
|
||||
Zip string `json:"zip"`
|
||||
Country string `json:"country"`
|
||||
TaxID string `json:"tax_id"`
|
||||
Phone string `json:"phone"`
|
||||
CreditCard *CreditCard `json:"credit_card"`
|
||||
}
|
||||
|
||||
// CreditCard information associated with the Account.
|
||||
type CreditCard struct {
|
||||
LastFour string `json:"last_four"`
|
||||
Expiry string `json:"expiry"`
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (v *Account) fixDates() *Account {
|
||||
return v
|
||||
}
|
||||
|
||||
// GetAccount gets the contact and billing information related to the Account
|
||||
func (c *Client) GetAccount(ctx context.Context) (*Account, error) {
|
||||
e, err := c.Account.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&Account{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Account).fixDates(), nil
|
||||
}
|
||||
|
|
@ -0,0 +1,277 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"log"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Event represents an action taken on the Account.
|
||||
type Event struct {
|
||||
CreatedStr string `json:"created"`
|
||||
|
||||
// The unique ID of this Event.
|
||||
ID int `json:"id"`
|
||||
|
||||
// Current status of the Event, Enum: "failed" "finished" "notification" "scheduled" "started"
|
||||
Status EventStatus `json:"status"`
|
||||
|
||||
// The action that caused this Event. New actions may be added in the future.
|
||||
Action EventAction `json:"action"`
|
||||
|
||||
// A percentage estimating the amount of time remaining for an Event. Returns null for notification events.
|
||||
PercentComplete int `json:"percent_complete"`
|
||||
|
||||
// The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events.
|
||||
Rate *string `json:"rate"`
|
||||
|
||||
// If this Event has been read.
|
||||
Read bool `json:"read"`
|
||||
|
||||
// If this Event has been seen.
|
||||
Seen bool `json:"seen"`
|
||||
|
||||
// The estimated time remaining until the completion of this Event. This value is only returned for in-progress events.
|
||||
TimeRemainingMsg json.RawMessage `json:"time_remaining"`
|
||||
TimeRemaining *int `json:"-"`
|
||||
|
||||
// The username of the User who caused the Event.
|
||||
Username string `json:"username"`
|
||||
|
||||
// Detailed information about the Event's entity, including ID, type, label, and URL used to access it.
|
||||
Entity *EventEntity `json:"entity"`
|
||||
|
||||
// When this Event was created.
|
||||
Created *time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// EventAction constants start with Action and include all known Linode API Event Actions.
|
||||
type EventAction string
|
||||
|
||||
// EventAction constants represent the actions that cause an Event. New actions may be added in the future.
|
||||
const (
|
||||
ActionBackupsEnable EventAction = "backups_enable"
|
||||
ActionBackupsCancel EventAction = "backups_cancel"
|
||||
ActionBackupsRestore EventAction = "backups_restore"
|
||||
ActionCommunityQuestionReply EventAction = "community_question_reply"
|
||||
ActionCreateCardUpdated EventAction = "credit_card_updated"
|
||||
ActionDiskCreate EventAction = "disk_create"
|
||||
ActionDiskDelete EventAction = "disk_delete"
|
||||
ActionDiskDuplicate EventAction = "disk_duplicate"
|
||||
ActionDiskImagize EventAction = "disk_imagize"
|
||||
ActionDiskResize EventAction = "disk_resize"
|
||||
ActionDNSRecordCreate EventAction = "dns_record_create"
|
||||
ActionDNSRecordDelete EventAction = "dns_record_delete"
|
||||
ActionDNSZoneCreate EventAction = "dns_zone_create"
|
||||
ActionDNSZoneDelete EventAction = "dns_zone_delete"
|
||||
ActionImageDelete EventAction = "image_delete"
|
||||
ActionLinodeAddIP EventAction = "linode_addip"
|
||||
ActionLinodeBoot EventAction = "linode_boot"
|
||||
ActionLinodeClone EventAction = "linode_clone"
|
||||
ActionLinodeCreate EventAction = "linode_create"
|
||||
ActionLinodeDelete EventAction = "linode_delete"
|
||||
ActionLinodeDeleteIP EventAction = "linode_deleteip"
|
||||
ActionLinodeMigrate EventAction = "linode_migrate"
|
||||
ActionLinodeMutate EventAction = "linode_mutate"
|
||||
ActionLinodeReboot EventAction = "linode_reboot"
|
||||
ActionLinodeRebuild EventAction = "linode_rebuild"
|
||||
ActionLinodeResize EventAction = "linode_resize"
|
||||
ActionLinodeShutdown EventAction = "linode_shutdown"
|
||||
ActionLinodeSnapshot EventAction = "linode_snapshot"
|
||||
ActionLongviewClientCreate EventAction = "longviewclient_create"
|
||||
ActionLongviewClientDelete EventAction = "longviewclient_delete"
|
||||
ActionManagedDisabled EventAction = "managed_disabled"
|
||||
ActionManagedEnabled EventAction = "managed_enabled"
|
||||
ActionManagedServiceCreate EventAction = "managed_service_create"
|
||||
ActionManagedServiceDelete EventAction = "managed_service_delete"
|
||||
ActionNodebalancerCreate EventAction = "nodebalancer_create"
|
||||
ActionNodebalancerDelete EventAction = "nodebalancer_delete"
|
||||
ActionNodebalancerConfigCreate EventAction = "nodebalancer_config_create"
|
||||
ActionNodebalancerConfigDelete EventAction = "nodebalancer_config_delete"
|
||||
ActionPasswordReset EventAction = "password_reset"
|
||||
ActionPaymentSubmitted EventAction = "payment_submitted"
|
||||
ActionStackScriptCreate EventAction = "stackscript_create"
|
||||
ActionStackScriptDelete EventAction = "stackscript_delete"
|
||||
ActionStackScriptPublicize EventAction = "stackscript_publicize"
|
||||
ActionStackScriptRevise EventAction = "stackscript_revise"
|
||||
ActionTFADisabled EventAction = "tfa_disabled"
|
||||
ActionTFAEnabled EventAction = "tfa_enabled"
|
||||
ActionTicketAttachmentUpload EventAction = "ticket_attachment_upload"
|
||||
ActionTicketCreate EventAction = "ticket_create"
|
||||
ActionTicketReply EventAction = "ticket_reply"
|
||||
ActionVolumeAttach EventAction = "volume_attach"
|
||||
ActionVolumeClone EventAction = "volume_clone"
|
||||
ActionVolumeCreate EventAction = "volume_create"
|
||||
ActionVolumeDelte EventAction = "volume_delete"
|
||||
ActionVolumeDetach EventAction = "volume_detach"
|
||||
ActionVolumeResize EventAction = "volume_resize"
|
||||
)
|
||||
|
||||
// EntityType constants start with Entity and include Linode API Event Entity Types
|
||||
type EntityType string
|
||||
|
||||
// EntityType contants are the entities an Event can be related to
|
||||
const (
|
||||
EntityLinode EntityType = "linode"
|
||||
EntityDisk EntityType = "disk"
|
||||
)
|
||||
|
||||
// EventStatus constants start with Event and include Linode API Event Status values
|
||||
type EventStatus string
|
||||
|
||||
// EventStatus constants reflect the current status of an Event
|
||||
const (
|
||||
EventFailed EventStatus = "failed"
|
||||
EventFinished EventStatus = "finished"
|
||||
EventNotification EventStatus = "notification"
|
||||
EventScheduled EventStatus = "scheduled"
|
||||
EventStarted EventStatus = "started"
|
||||
)
|
||||
|
||||
// EventEntity provides detailed information about the Event's
|
||||
// associated entity, including ID, Type, Label, and a URL that
|
||||
// can be used to access it.
|
||||
type EventEntity struct {
|
||||
// ID may be a string or int, it depends on the EntityType
|
||||
ID interface{} `json:"id"`
|
||||
Label string `json:"label"`
|
||||
Type EntityType `json:"type"`
|
||||
URL string `json:"url"`
|
||||
}
|
||||
|
||||
// EventsPagedResponse represents a paginated Events API response
|
||||
type EventsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Event `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for Event
|
||||
func (EventsPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Events.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// endpointWithID gets the endpoint URL for a specific Event
|
||||
func (e Event) endpointWithID(c *Client) string {
|
||||
endpoint, err := c.Events.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
endpoint = fmt.Sprintf("%s/%d", endpoint, e.ID)
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends Events when processing paginated Event responses
|
||||
func (resp *EventsPagedResponse) appendData(r *EventsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListEvents gets a collection of Event objects representing actions taken
|
||||
// on the Account. The Events returned depend on the token grants and the grants
|
||||
// of the associated user.
|
||||
func (c *Client) ListEvents(ctx context.Context, opts *ListOptions) ([]Event, error) {
|
||||
response := EventsPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// GetEvent gets the Event with the Event ID
|
||||
func (c *Client) GetEvent(ctx context.Context, id int) (*Event, error) {
|
||||
e, err := c.Events.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
r, err := c.R(ctx).SetResult(&Event{}).Get(e)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Event).fixDates(), nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (e *Event) fixDates() *Event {
|
||||
e.Created, _ = parseDates(e.CreatedStr)
|
||||
e.TimeRemaining = unmarshalTimeRemaining(e.TimeRemainingMsg)
|
||||
return e
|
||||
}
|
||||
|
||||
// MarkEventRead marks a single Event as read.
|
||||
func (c *Client) MarkEventRead(ctx context.Context, event *Event) error {
|
||||
e := event.endpointWithID(c)
|
||||
e = fmt.Sprintf("%s/read", e)
|
||||
|
||||
_, err := coupleAPIErrors(c.R(ctx).Post(e))
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
// MarkEventsSeen marks all Events up to and including this Event by ID as seen.
|
||||
func (c *Client) MarkEventsSeen(ctx context.Context, event *Event) error {
|
||||
e := event.endpointWithID(c)
|
||||
e = fmt.Sprintf("%s/seen", e)
|
||||
|
||||
_, err := coupleAPIErrors(c.R(ctx).Post(e))
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
func unmarshalTimeRemaining(m json.RawMessage) *int {
|
||||
jsonBytes, err := m.MarshalJSON()
|
||||
if err != nil {
|
||||
panic(jsonBytes)
|
||||
}
|
||||
|
||||
if len(jsonBytes) == 4 && string(jsonBytes) == "null" {
|
||||
return nil
|
||||
}
|
||||
|
||||
var timeStr string
|
||||
if err := json.Unmarshal(jsonBytes, &timeStr); err == nil && len(timeStr) > 0 {
|
||||
if dur, err := durationToSeconds(timeStr); err != nil {
|
||||
panic(err)
|
||||
} else {
|
||||
return &dur
|
||||
}
|
||||
} else {
|
||||
var intPtr int
|
||||
if err := json.Unmarshal(jsonBytes, &intPtr); err == nil {
|
||||
return &intPtr
|
||||
}
|
||||
}
|
||||
|
||||
log.Println("[WARN] Unexpected unmarshalTimeRemaining value: ", jsonBytes)
|
||||
return nil
|
||||
}
|
||||
|
||||
// durationToSeconds takes a hh:mm:ss string and returns the number of seconds
|
||||
func durationToSeconds(s string) (int, error) {
|
||||
multipliers := [3]int{60 * 60, 60, 1}
|
||||
segs := strings.Split(s, ":")
|
||||
if len(segs) > len(multipliers) {
|
||||
return 0, fmt.Errorf("too many ':' separators in time duration: %s", s)
|
||||
}
|
||||
var d int
|
||||
l := len(segs)
|
||||
for i := 0; i < l; i++ {
|
||||
m, err := strconv.Atoi(segs[i])
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
d += m * multipliers[i+len(multipliers)-l]
|
||||
}
|
||||
return d, nil
|
||||
}
|
||||
|
|
@ -0,0 +1,125 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Invoice structs reflect an invoice for billable activity on the account.
|
||||
type Invoice struct {
|
||||
DateStr string `json:"date"`
|
||||
|
||||
ID int `json:"id"`
|
||||
Label string `json:"label"`
|
||||
Total float32 `json:"total"`
|
||||
Date *time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// InvoiceItem structs reflect an single billable activity associate with an Invoice
|
||||
type InvoiceItem struct {
|
||||
FromStr string `json:"from"`
|
||||
ToStr string `json:"to"`
|
||||
|
||||
Label string `json:"label"`
|
||||
Type string `json:"type"`
|
||||
UnitPrice int `json:"unitprice"`
|
||||
Quantity int `json:"quantity"`
|
||||
Amount float32 `json:"amount"`
|
||||
From *time.Time `json:"-"`
|
||||
To *time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// InvoicesPagedResponse represents a paginated Invoice API response
|
||||
type InvoicesPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Invoice `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for Invoice
|
||||
func (InvoicesPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Invoices.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends Invoices when processing paginated Invoice responses
|
||||
func (resp *InvoicesPagedResponse) appendData(r *InvoicesPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListInvoices gets a paginated list of Invoices against the Account
|
||||
func (c *Client) ListInvoices(ctx context.Context, opts *ListOptions) ([]Invoice, error) {
|
||||
response := InvoicesPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (v *Invoice) fixDates() *Invoice {
|
||||
v.Date, _ = parseDates(v.DateStr)
|
||||
return v
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (v *InvoiceItem) fixDates() *InvoiceItem {
|
||||
v.From, _ = parseDates(v.FromStr)
|
||||
v.To, _ = parseDates(v.ToStr)
|
||||
return v
|
||||
}
|
||||
|
||||
// GetInvoice gets the a single Invoice matching the provided ID
|
||||
func (c *Client) GetInvoice(ctx context.Context, id int) (*Invoice, error) {
|
||||
e, err := c.Invoices.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&Invoice{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Invoice).fixDates(), nil
|
||||
}
|
||||
|
||||
// InvoiceItemsPagedResponse represents a paginated Invoice Item API response
|
||||
type InvoiceItemsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []InvoiceItem `json:"data"`
|
||||
}
|
||||
|
||||
// endpointWithID gets the endpoint URL for InvoiceItems associated with a specific Invoice
|
||||
func (InvoiceItemsPagedResponse) endpointWithID(c *Client, id int) string {
|
||||
endpoint, err := c.InvoiceItems.endpointWithID(id)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends InvoiceItems when processing paginated Invoice Item responses
|
||||
func (resp *InvoiceItemsPagedResponse) appendData(r *InvoiceItemsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListInvoiceItems gets the invoice items associated with a specific Invoice
|
||||
func (c *Client) ListInvoiceItems(ctx context.Context, id int, opts *ListOptions) ([]InvoiceItem, error) {
|
||||
response := InvoiceItemsPagedResponse{}
|
||||
err := c.listHelperWithID(ctx, &response, id, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Notification represents a notification on an Account
|
||||
type Notification struct {
|
||||
UntilStr string `json:"until"`
|
||||
WhenStr string `json:"when"`
|
||||
|
||||
Label string `json:"label"`
|
||||
Body *string `json:"body"`
|
||||
Message string `json:"message"`
|
||||
Type NotificationType `json:"type"`
|
||||
Severity NotificationSeverity `json:"severity"`
|
||||
Entity *NotificationEntity `json:"entity"`
|
||||
Until *time.Time `json:"-"`
|
||||
When *time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// NotificationEntity adds detailed information about the Notification.
|
||||
// This could refer to the ticket that triggered the notification, for example.
|
||||
type NotificationEntity struct {
|
||||
ID int `json:"id"`
|
||||
Label string `json:"label"`
|
||||
Type string `json:"type"`
|
||||
URL string `json:"url"`
|
||||
}
|
||||
|
||||
// NotificationSeverity constants start with Notification and include all known Linode API Notification Severities.
|
||||
type NotificationSeverity string
|
||||
|
||||
// NotificationSeverity constants represent the actions that cause a Notification. New severities may be added in the future.
|
||||
const (
|
||||
NotificationMinor NotificationSeverity = "minor"
|
||||
NotificationMajor NotificationSeverity = "major"
|
||||
NotificationCritical NotificationSeverity = "critical"
|
||||
)
|
||||
|
||||
// NotificationType constants start with Notification and include all known Linode API Notification Types.
|
||||
type NotificationType string
|
||||
|
||||
// NotificationType constants represent the actions that cause a Notification. New types may be added in the future.
|
||||
const (
|
||||
NotificationMigrationScheduled NotificationType = "migration_scheduled"
|
||||
NotificationMigrationImminent NotificationType = "migration_imminent"
|
||||
NotificationMigrationPending NotificationType = "migration_pending"
|
||||
NotificationRebootScheduled NotificationType = "reboot_scheduled"
|
||||
NotificationOutage NotificationType = "outage"
|
||||
NotificationPaymentDue NotificationType = "payment_due"
|
||||
NotificationTicketImportant NotificationType = "ticket_important"
|
||||
NotificationTicketAbuse NotificationType = "ticket_abuse"
|
||||
NotificationNotice NotificationType = "notice"
|
||||
NotificationMaintenance NotificationType = "maintenance"
|
||||
)
|
||||
|
||||
// NotificationsPagedResponse represents a paginated Notifications API response
|
||||
type NotificationsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Notification `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for Notification
|
||||
func (NotificationsPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Notifications.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends Notifications when processing paginated Notification responses
|
||||
func (resp *NotificationsPagedResponse) appendData(r *NotificationsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListNotifications gets a collection of Notification objects representing important,
|
||||
// often time-sensitive items related to the Account. An account cannot interact directly with
|
||||
// Notifications, and a Notification will disappear when the circumstances causing it
|
||||
// have been resolved. For example, if the account has an important Ticket open, a response
|
||||
// to the Ticket will dismiss the Notification.
|
||||
func (c *Client) ListNotifications(ctx context.Context, opts *ListOptions) ([]Notification, error) {
|
||||
response := NotificationsPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (v *Notification) fixDates() *Notification {
|
||||
v.Until, _ = parseDates(v.UntilStr)
|
||||
v.When, _ = parseDates(v.WhenStr)
|
||||
return v
|
||||
}
|
||||
|
|
@ -0,0 +1,164 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// User represents a User object
|
||||
type User struct {
|
||||
Username string `json:"username"`
|
||||
Email string `json:"email"`
|
||||
Restricted bool `json:"restricted"`
|
||||
SSHKeys []string `json:"ssh_keys"`
|
||||
}
|
||||
|
||||
// UserCreateOptions fields are those accepted by CreateUser
|
||||
type UserCreateOptions struct {
|
||||
Username string `json:"username"`
|
||||
Email string `json:"email"`
|
||||
Restricted bool `json:"restricted,omitempty"`
|
||||
}
|
||||
|
||||
// UserUpdateOptions fields are those accepted by UpdateUser
|
||||
type UserUpdateOptions struct {
|
||||
Username string `json:"username,omitempty"`
|
||||
Email string `json:"email,omitempty"`
|
||||
Restricted *bool `json:"restricted,omitempty"`
|
||||
SSHKeys *[]string `json:"ssh_keys,omitempty"`
|
||||
}
|
||||
|
||||
// GetCreateOptions converts a User to UserCreateOptions for use in CreateUser
|
||||
func (i User) GetCreateOptions() (o UserCreateOptions) {
|
||||
o.Username = i.Username
|
||||
o.Email = i.Email
|
||||
o.Restricted = i.Restricted
|
||||
return
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts a User to UserUpdateOptions for use in UpdateUser
|
||||
func (i User) GetUpdateOptions() (o UserUpdateOptions) {
|
||||
o.Username = i.Username
|
||||
o.Email = i.Email
|
||||
o.Restricted = copyBool(&i.Restricted)
|
||||
return
|
||||
}
|
||||
|
||||
// UsersPagedResponse represents a paginated User API response
|
||||
type UsersPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []User `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for User
|
||||
func (UsersPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Users.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends Users when processing paginated User responses
|
||||
func (resp *UsersPagedResponse) appendData(r *UsersPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListUsers lists Users on the account
|
||||
func (c *Client) ListUsers(ctx context.Context, opts *ListOptions) ([]User, error) {
|
||||
response := UsersPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (i *User) fixDates() *User {
|
||||
return i
|
||||
}
|
||||
|
||||
// GetUser gets the user with the provided ID
|
||||
func (c *Client) GetUser(ctx context.Context, id string) (*User, error) {
|
||||
e, err := c.Users.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&User{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*User).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateUser creates a User. The email address must be confirmed before the
|
||||
// User account can be accessed.
|
||||
func (c *Client) CreateUser(ctx context.Context, createOpts UserCreateOptions) (*User, error) {
|
||||
var body string
|
||||
e, err := c.Users.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&User{})
|
||||
|
||||
if bodyData, err := json.Marshal(createOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*User).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateUser updates the User with the specified id
|
||||
func (c *Client) UpdateUser(ctx context.Context, id string, updateOpts UserUpdateOptions) (*User, error) {
|
||||
var body string
|
||||
e, err := c.Users.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, id)
|
||||
|
||||
req := c.R(ctx).SetResult(&User{})
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*User).fixDates(), nil
|
||||
}
|
||||
|
||||
// DeleteUser deletes the User with the specified id
|
||||
func (c *Client) DeleteUser(ctx context.Context, id string) error {
|
||||
e, err := c.Users.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,257 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log"
|
||||
"net/http"
|
||||
"os"
|
||||
"strconv"
|
||||
"time"
|
||||
|
||||
"gopkg.in/resty.v1"
|
||||
)
|
||||
|
||||
const (
|
||||
// APIHost Linode API hostname
|
||||
APIHost = "api.linode.com"
|
||||
// APIVersion Linode API version
|
||||
APIVersion = "v4"
|
||||
// APIProto connect to API with http(s)
|
||||
APIProto = "https"
|
||||
// Version of linodego
|
||||
Version = "0.7.0"
|
||||
// APIEnvVar environment var to check for API token
|
||||
APIEnvVar = "LINODE_TOKEN"
|
||||
// APISecondsPerPoll how frequently to poll for new Events or Status in WaitFor functions
|
||||
APISecondsPerPoll = 3
|
||||
// DefaultUserAgent is the default User-Agent sent in HTTP request headers
|
||||
DefaultUserAgent = "linodego " + Version + " https://github.com/linode/linodego"
|
||||
)
|
||||
|
||||
var (
|
||||
envDebug = false
|
||||
)
|
||||
|
||||
// Client is a wrapper around the Resty client
|
||||
type Client struct {
|
||||
resty *resty.Client
|
||||
userAgent string
|
||||
resources map[string]*Resource
|
||||
debug bool
|
||||
|
||||
millisecondsPerPoll time.Duration
|
||||
|
||||
Images *Resource
|
||||
InstanceDisks *Resource
|
||||
InstanceConfigs *Resource
|
||||
InstanceSnapshots *Resource
|
||||
InstanceIPs *Resource
|
||||
InstanceVolumes *Resource
|
||||
Instances *Resource
|
||||
IPAddresses *Resource
|
||||
IPv6Pools *Resource
|
||||
IPv6Ranges *Resource
|
||||
Regions *Resource
|
||||
StackScripts *Resource
|
||||
Volumes *Resource
|
||||
Kernels *Resource
|
||||
Types *Resource
|
||||
Domains *Resource
|
||||
DomainRecords *Resource
|
||||
Longview *Resource
|
||||
LongviewClients *Resource
|
||||
LongviewSubscriptions *Resource
|
||||
NodeBalancers *Resource
|
||||
NodeBalancerConfigs *Resource
|
||||
NodeBalancerNodes *Resource
|
||||
SSHKeys *Resource
|
||||
Tickets *Resource
|
||||
Tokens *Resource
|
||||
Token *Resource
|
||||
Account *Resource
|
||||
Invoices *Resource
|
||||
InvoiceItems *Resource
|
||||
Events *Resource
|
||||
Notifications *Resource
|
||||
Profile *Resource
|
||||
Managed *Resource
|
||||
Tags *Resource
|
||||
Users *Resource
|
||||
}
|
||||
|
||||
func init() {
|
||||
// Wether or not we will enable Resty debugging output
|
||||
if apiDebug, ok := os.LookupEnv("LINODE_DEBUG"); ok {
|
||||
if parsed, err := strconv.ParseBool(apiDebug); err == nil {
|
||||
envDebug = parsed
|
||||
log.Println("[INFO] LINODE_DEBUG being set to", envDebug)
|
||||
} else {
|
||||
log.Println("[WARN] LINODE_DEBUG should be an integer, 0 or 1")
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
// SetUserAgent sets a custom user-agent for HTTP requests
|
||||
func (c *Client) SetUserAgent(ua string) *Client {
|
||||
c.userAgent = ua
|
||||
c.resty.SetHeader("User-Agent", c.userAgent)
|
||||
|
||||
return c
|
||||
}
|
||||
|
||||
// R wraps resty's R method
|
||||
func (c *Client) R(ctx context.Context) *resty.Request {
|
||||
return c.resty.R().
|
||||
ExpectContentType("application/json").
|
||||
SetHeader("Content-Type", "application/json").
|
||||
SetContext(ctx).
|
||||
SetError(APIError{})
|
||||
}
|
||||
|
||||
// SetDebug sets the debug on resty's client
|
||||
func (c *Client) SetDebug(debug bool) *Client {
|
||||
c.debug = debug
|
||||
c.resty.SetDebug(debug)
|
||||
return c
|
||||
}
|
||||
|
||||
// SetBaseURL sets the base URL of the Linode v4 API (https://api.linode.com/v4)
|
||||
func (c *Client) SetBaseURL(url string) *Client {
|
||||
c.resty.SetHostURL(url)
|
||||
return c
|
||||
}
|
||||
|
||||
// SetPollDelay sets the number of milliseconds to wait between events or status polls.
|
||||
// Affects all WaitFor* functions.
|
||||
func (c *Client) SetPollDelay(delay time.Duration) *Client {
|
||||
c.millisecondsPerPoll = delay
|
||||
return c
|
||||
}
|
||||
|
||||
// Resource looks up a resource by name
|
||||
func (c Client) Resource(resourceName string) *Resource {
|
||||
selectedResource, ok := c.resources[resourceName]
|
||||
if !ok {
|
||||
log.Fatalf("Could not find resource named '%s', exiting.", resourceName)
|
||||
}
|
||||
return selectedResource
|
||||
}
|
||||
|
||||
// NewClient factory to create new Client struct
|
||||
func NewClient(hc *http.Client) (client Client) {
|
||||
restyClient := resty.NewWithClient(hc)
|
||||
client.resty = restyClient
|
||||
client.SetUserAgent(DefaultUserAgent)
|
||||
client.SetBaseURL(fmt.Sprintf("%s://%s/%s", APIProto, APIHost, APIVersion))
|
||||
client.SetPollDelay(1000 * APISecondsPerPoll)
|
||||
|
||||
resources := map[string]*Resource{
|
||||
stackscriptsName: NewResource(&client, stackscriptsName, stackscriptsEndpoint, false, Stackscript{}, StackscriptsPagedResponse{}),
|
||||
imagesName: NewResource(&client, imagesName, imagesEndpoint, false, Image{}, ImagesPagedResponse{}),
|
||||
instancesName: NewResource(&client, instancesName, instancesEndpoint, false, Instance{}, InstancesPagedResponse{}),
|
||||
instanceDisksName: NewResource(&client, instanceDisksName, instanceDisksEndpoint, true, InstanceDisk{}, InstanceDisksPagedResponse{}),
|
||||
instanceConfigsName: NewResource(&client, instanceConfigsName, instanceConfigsEndpoint, true, InstanceConfig{}, InstanceConfigsPagedResponse{}),
|
||||
instanceSnapshotsName: NewResource(&client, instanceSnapshotsName, instanceSnapshotsEndpoint, true, InstanceSnapshot{}, nil),
|
||||
instanceIPsName: NewResource(&client, instanceIPsName, instanceIPsEndpoint, true, InstanceIP{}, nil), // really?
|
||||
instanceVolumesName: NewResource(&client, instanceVolumesName, instanceVolumesEndpoint, true, nil, InstanceVolumesPagedResponse{}), // really?
|
||||
ipaddressesName: NewResource(&client, ipaddressesName, ipaddressesEndpoint, false, nil, IPAddressesPagedResponse{}), // really?
|
||||
ipv6poolsName: NewResource(&client, ipv6poolsName, ipv6poolsEndpoint, false, nil, IPv6PoolsPagedResponse{}), // really?
|
||||
ipv6rangesName: NewResource(&client, ipv6rangesName, ipv6rangesEndpoint, false, IPv6Range{}, IPv6RangesPagedResponse{}),
|
||||
regionsName: NewResource(&client, regionsName, regionsEndpoint, false, Region{}, RegionsPagedResponse{}),
|
||||
volumesName: NewResource(&client, volumesName, volumesEndpoint, false, Volume{}, VolumesPagedResponse{}),
|
||||
kernelsName: NewResource(&client, kernelsName, kernelsEndpoint, false, LinodeKernel{}, LinodeKernelsPagedResponse{}),
|
||||
typesName: NewResource(&client, typesName, typesEndpoint, false, LinodeType{}, LinodeTypesPagedResponse{}),
|
||||
domainsName: NewResource(&client, domainsName, domainsEndpoint, false, Domain{}, DomainsPagedResponse{}),
|
||||
domainRecordsName: NewResource(&client, domainRecordsName, domainRecordsEndpoint, true, DomainRecord{}, DomainRecordsPagedResponse{}),
|
||||
longviewName: NewResource(&client, longviewName, longviewEndpoint, false, nil, nil), // really?
|
||||
longviewclientsName: NewResource(&client, longviewclientsName, longviewclientsEndpoint, false, LongviewClient{}, LongviewClientsPagedResponse{}),
|
||||
longviewsubscriptionsName: NewResource(&client, longviewsubscriptionsName, longviewsubscriptionsEndpoint, false, LongviewSubscription{}, LongviewSubscriptionsPagedResponse{}),
|
||||
nodebalancersName: NewResource(&client, nodebalancersName, nodebalancersEndpoint, false, NodeBalancer{}, NodeBalancerConfigsPagedResponse{}),
|
||||
nodebalancerconfigsName: NewResource(&client, nodebalancerconfigsName, nodebalancerconfigsEndpoint, true, NodeBalancerConfig{}, NodeBalancerConfigsPagedResponse{}),
|
||||
nodebalancernodesName: NewResource(&client, nodebalancernodesName, nodebalancernodesEndpoint, true, NodeBalancerNode{}, NodeBalancerNodesPagedResponse{}),
|
||||
notificationsName: NewResource(&client, notificationsName, notificationsEndpoint, false, Notification{}, NotificationsPagedResponse{}),
|
||||
sshkeysName: NewResource(&client, sshkeysName, sshkeysEndpoint, false, SSHKey{}, SSHKeysPagedResponse{}),
|
||||
ticketsName: NewResource(&client, ticketsName, ticketsEndpoint, false, Ticket{}, TicketsPagedResponse{}),
|
||||
tokensName: NewResource(&client, tokensName, tokensEndpoint, false, Token{}, TokensPagedResponse{}),
|
||||
accountName: NewResource(&client, accountName, accountEndpoint, false, Account{}, nil), // really?
|
||||
eventsName: NewResource(&client, eventsName, eventsEndpoint, false, Event{}, EventsPagedResponse{}),
|
||||
invoicesName: NewResource(&client, invoicesName, invoicesEndpoint, false, Invoice{}, InvoicesPagedResponse{}),
|
||||
invoiceItemsName: NewResource(&client, invoiceItemsName, invoiceItemsEndpoint, true, InvoiceItem{}, InvoiceItemsPagedResponse{}),
|
||||
profileName: NewResource(&client, profileName, profileEndpoint, false, nil, nil), // really?
|
||||
managedName: NewResource(&client, managedName, managedEndpoint, false, nil, nil), // really?
|
||||
tagsName: NewResource(&client, tagsName, tagsEndpoint, false, Tag{}, TagsPagedResponse{}),
|
||||
usersName: NewResource(&client, usersName, usersEndpoint, false, User{}, UsersPagedResponse{}),
|
||||
}
|
||||
|
||||
client.resources = resources
|
||||
|
||||
client.SetDebug(envDebug)
|
||||
client.Images = resources[imagesName]
|
||||
client.StackScripts = resources[stackscriptsName]
|
||||
client.Instances = resources[instancesName]
|
||||
client.Regions = resources[regionsName]
|
||||
client.InstanceDisks = resources[instanceDisksName]
|
||||
client.InstanceConfigs = resources[instanceConfigsName]
|
||||
client.InstanceSnapshots = resources[instanceSnapshotsName]
|
||||
client.InstanceIPs = resources[instanceIPsName]
|
||||
client.InstanceVolumes = resources[instanceVolumesName]
|
||||
client.IPAddresses = resources[ipaddressesName]
|
||||
client.IPv6Pools = resources[ipv6poolsName]
|
||||
client.IPv6Ranges = resources[ipv6rangesName]
|
||||
client.Volumes = resources[volumesName]
|
||||
client.Kernels = resources[kernelsName]
|
||||
client.Types = resources[typesName]
|
||||
client.Domains = resources[domainsName]
|
||||
client.DomainRecords = resources[domainRecordsName]
|
||||
client.Longview = resources[longviewName]
|
||||
client.LongviewSubscriptions = resources[longviewsubscriptionsName]
|
||||
client.NodeBalancers = resources[nodebalancersName]
|
||||
client.NodeBalancerConfigs = resources[nodebalancerconfigsName]
|
||||
client.NodeBalancerNodes = resources[nodebalancernodesName]
|
||||
client.Notifications = resources[notificationsName]
|
||||
client.SSHKeys = resources[sshkeysName]
|
||||
client.Tickets = resources[ticketsName]
|
||||
client.Tokens = resources[tokensName]
|
||||
client.Account = resources[accountName]
|
||||
client.Events = resources[eventsName]
|
||||
client.Invoices = resources[invoicesName]
|
||||
client.Profile = resources[profileName]
|
||||
client.Managed = resources[managedName]
|
||||
client.Tags = resources[tagsName]
|
||||
client.Users = resources[usersName]
|
||||
return
|
||||
}
|
||||
|
||||
func copyBool(bPtr *bool) *bool {
|
||||
if bPtr == nil {
|
||||
return nil
|
||||
}
|
||||
var t = *bPtr
|
||||
return &t
|
||||
}
|
||||
|
||||
func copyInt(iPtr *int) *int {
|
||||
if iPtr == nil {
|
||||
return nil
|
||||
}
|
||||
var t = *iPtr
|
||||
return &t
|
||||
}
|
||||
|
||||
func copyString(sPtr *string) *string {
|
||||
if sPtr == nil {
|
||||
return nil
|
||||
}
|
||||
var t = *sPtr
|
||||
return &t
|
||||
}
|
||||
|
||||
func copyTime(tPtr *time.Time) *time.Time {
|
||||
if tPtr == nil {
|
||||
return nil
|
||||
}
|
||||
var t = *tPtr
|
||||
return &t
|
||||
}
|
||||
|
|
@ -0,0 +1,195 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// DomainRecord represents a DomainRecord object
|
||||
type DomainRecord struct {
|
||||
ID int `json:"id"`
|
||||
Type DomainRecordType `json:"type"`
|
||||
Name string `json:"name"`
|
||||
Target string `json:"target"`
|
||||
Priority int `json:"priority"`
|
||||
Weight int `json:"weight"`
|
||||
Port int `json:"port"`
|
||||
Service *string `json:"service"`
|
||||
Protocol *string `json:"protocol"`
|
||||
TTLSec int `json:"ttl_sec"`
|
||||
Tag *string `json:"tag"`
|
||||
}
|
||||
|
||||
// DomainRecordCreateOptions fields are those accepted by CreateDomainRecord
|
||||
type DomainRecordCreateOptions struct {
|
||||
Type DomainRecordType `json:"type"`
|
||||
Name string `json:"name"`
|
||||
Target string `json:"target"`
|
||||
Priority *int `json:"priority,omitempty"`
|
||||
Weight *int `json:"weight,omitempty"`
|
||||
Port *int `json:"port,omitempty"`
|
||||
Service *string `json:"service,omitempty"`
|
||||
Protocol *string `json:"protocol,omitempty"`
|
||||
TTLSec int `json:"ttl_sec,omitempty"` // 0 is not accepted by Linode, so can be omitted
|
||||
Tag *string `json:"tag,omitempty"`
|
||||
}
|
||||
|
||||
// DomainRecordUpdateOptions fields are those accepted by UpdateDomainRecord
|
||||
type DomainRecordUpdateOptions struct {
|
||||
Type DomainRecordType `json:"type,omitempty"`
|
||||
Name string `json:"name,omitempty"`
|
||||
Target string `json:"target,omitempty"`
|
||||
Priority *int `json:"priority,omitempty"` // 0 is valid, so omit only nil values
|
||||
Weight *int `json:"weight,omitempty"` // 0 is valid, so omit only nil values
|
||||
Port *int `json:"port,omitempty"` // 0 is valid to spec, so omit only nil values
|
||||
Service *string `json:"service,omitempty"`
|
||||
Protocol *string `json:"protocol,omitempty"`
|
||||
TTLSec int `json:"ttl_sec,omitempty"` // 0 is not accepted by Linode, so can be omitted
|
||||
Tag *string `json:"tag,omitempty"`
|
||||
}
|
||||
|
||||
// DomainRecordType constants start with RecordType and include Linode API Domain Record Types
|
||||
type DomainRecordType string
|
||||
|
||||
// DomainRecordType contants are the DNS record types a DomainRecord can assign
|
||||
const (
|
||||
RecordTypeA DomainRecordType = "A"
|
||||
RecordTypeAAAA DomainRecordType = "AAAA"
|
||||
RecordTypeNS DomainRecordType = "NS"
|
||||
RecordTypeMX DomainRecordType = "MX"
|
||||
RecordTypeCNAME DomainRecordType = "CNAME"
|
||||
RecordTypeTXT DomainRecordType = "TXT"
|
||||
RecordTypeSRV DomainRecordType = "SRV"
|
||||
RecordTypePTR DomainRecordType = "PTR"
|
||||
RecordTypeCAA DomainRecordType = "CAA"
|
||||
)
|
||||
|
||||
// GetUpdateOptions converts a DomainRecord to DomainRecordUpdateOptions for use in UpdateDomainRecord
|
||||
func (d DomainRecord) GetUpdateOptions() (du DomainRecordUpdateOptions) {
|
||||
du.Type = d.Type
|
||||
du.Name = d.Name
|
||||
du.Target = d.Target
|
||||
du.Priority = copyInt(&d.Priority)
|
||||
du.Weight = copyInt(&d.Weight)
|
||||
du.Port = copyInt(&d.Port)
|
||||
du.Service = copyString(d.Service)
|
||||
du.Protocol = copyString(d.Protocol)
|
||||
du.TTLSec = d.TTLSec
|
||||
du.Tag = copyString(d.Tag)
|
||||
return
|
||||
}
|
||||
|
||||
// DomainRecordsPagedResponse represents a paginated DomainRecord API response
|
||||
type DomainRecordsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []DomainRecord `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for InstanceConfig
|
||||
func (DomainRecordsPagedResponse) endpointWithID(c *Client, id int) string {
|
||||
endpoint, err := c.DomainRecords.endpointWithID(id)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends DomainRecords when processing paginated DomainRecord responses
|
||||
func (resp *DomainRecordsPagedResponse) appendData(r *DomainRecordsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListDomainRecords lists DomainRecords
|
||||
func (c *Client) ListDomainRecords(ctx context.Context, domainID int, opts *ListOptions) ([]DomainRecord, error) {
|
||||
response := DomainRecordsPagedResponse{}
|
||||
err := c.listHelperWithID(ctx, &response, domainID, opts)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (d *DomainRecord) fixDates() *DomainRecord {
|
||||
return d
|
||||
}
|
||||
|
||||
// GetDomainRecord gets the domainrecord with the provided ID
|
||||
func (c *Client) GetDomainRecord(ctx context.Context, domainID int, id int) (*DomainRecord, error) {
|
||||
e, err := c.DomainRecords.endpointWithID(domainID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&DomainRecord{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*DomainRecord), nil
|
||||
}
|
||||
|
||||
// CreateDomainRecord creates a DomainRecord
|
||||
func (c *Client) CreateDomainRecord(ctx context.Context, domainID int, domainrecord DomainRecordCreateOptions) (*DomainRecord, error) {
|
||||
var body string
|
||||
e, err := c.DomainRecords.endpointWithID(domainID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&DomainRecord{})
|
||||
|
||||
bodyData, err := json.Marshal(domainrecord)
|
||||
if err != nil {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
body = string(bodyData)
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*DomainRecord).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateDomainRecord updates the DomainRecord with the specified id
|
||||
func (c *Client) UpdateDomainRecord(ctx context.Context, domainID int, id int, domainrecord DomainRecordUpdateOptions) (*DomainRecord, error) {
|
||||
var body string
|
||||
e, err := c.DomainRecords.endpointWithID(domainID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
req := c.R(ctx).SetResult(&DomainRecord{})
|
||||
|
||||
if bodyData, err := json.Marshal(domainrecord); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*DomainRecord).fixDates(), nil
|
||||
}
|
||||
|
||||
// DeleteDomainRecord deletes the DomainRecord with the specified id
|
||||
func (c *Client) DeleteDomainRecord(ctx context.Context, domainID int, id int) error {
|
||||
e, err := c.DomainRecords.endpointWithID(domainID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,295 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// Domain represents a Domain object
|
||||
type Domain struct {
|
||||
// This Domain's unique ID
|
||||
ID int `json:"id"`
|
||||
|
||||
// The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain.
|
||||
Domain string `json:"domain"`
|
||||
|
||||
// If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave).
|
||||
Type DomainType `json:"type"` // Enum:"master" "slave"
|
||||
|
||||
// Deprecated: The group this Domain belongs to. This is for display purposes only.
|
||||
Group string `json:"group"`
|
||||
|
||||
// Used to control whether this Domain is currently being rendered.
|
||||
Status DomainStatus `json:"status"` // Enum:"disabled" "active" "edit_mode" "has_errors"
|
||||
|
||||
// A description for this Domain. This is for display purposes only.
|
||||
Description string `json:"description"`
|
||||
|
||||
// Start of Authority email address. This is required for master Domains.
|
||||
SOAEmail string `json:"soa_email"`
|
||||
|
||||
// The interval, in seconds, at which a failed refresh should be retried.
|
||||
// Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
|
||||
RetrySec int `json:"retry_sec"`
|
||||
|
||||
// The IP addresses representing the master DNS for this Domain.
|
||||
MasterIPs []string `json:"master_ips"`
|
||||
|
||||
// The list of IPs that may perform a zone transfer for this Domain. This is potentially dangerous, and should be set to an empty list unless you intend to use it.
|
||||
AXfrIPs []string `json:"axfr_ips"`
|
||||
|
||||
// An array of tags applied to this object. Tags are for organizational purposes only.
|
||||
Tags []string `json:"tags"`
|
||||
|
||||
// The amount of time in seconds that may pass before this Domain is no longer authoritative. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
|
||||
ExpireSec int `json:"expire_sec"`
|
||||
|
||||
// The amount of time in seconds before this Domain should be refreshed. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
|
||||
RefreshSec int `json:"refresh_sec"`
|
||||
|
||||
// "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
|
||||
TTLSec int `json:"ttl_sec"`
|
||||
}
|
||||
|
||||
// DomainCreateOptions fields are those accepted by CreateDomain
|
||||
type DomainCreateOptions struct {
|
||||
// The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain.
|
||||
Domain string `json:"domain"`
|
||||
|
||||
// If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave).
|
||||
// Enum:"master" "slave"
|
||||
Type DomainType `json:"type"`
|
||||
|
||||
// Deprecated: The group this Domain belongs to. This is for display purposes only.
|
||||
Group string `json:"group,omitempty"`
|
||||
|
||||
// Used to control whether this Domain is currently being rendered.
|
||||
// Enum:"disabled" "active" "edit_mode" "has_errors"
|
||||
Status DomainStatus `json:"status,omitempty"`
|
||||
|
||||
// A description for this Domain. This is for display purposes only.
|
||||
Description string `json:"description,omitempty"`
|
||||
|
||||
// Start of Authority email address. This is required for master Domains.
|
||||
SOAEmail string `json:"soa_email,omitempty"`
|
||||
|
||||
// The interval, in seconds, at which a failed refresh should be retried.
|
||||
// Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
|
||||
RetrySec int `json:"retry_sec,omitempty"`
|
||||
|
||||
// The IP addresses representing the master DNS for this Domain.
|
||||
MasterIPs []string `json:"master_ips,omitempty"`
|
||||
|
||||
// The list of IPs that may perform a zone transfer for this Domain. This is potentially dangerous, and should be set to an empty list unless you intend to use it.
|
||||
AXfrIPs []string `json:"axfr_ips,omitempty"`
|
||||
|
||||
// An array of tags applied to this object. Tags are for organizational purposes only.
|
||||
Tags []string `json:"tags"`
|
||||
|
||||
// The amount of time in seconds that may pass before this Domain is no longer authoritative. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
|
||||
ExpireSec int `json:"expire_sec,omitempty"`
|
||||
|
||||
// The amount of time in seconds before this Domain should be refreshed. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
|
||||
RefreshSec int `json:"refresh_sec,omitempty"`
|
||||
|
||||
// "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
|
||||
TTLSec int `json:"ttl_sec,omitempty"`
|
||||
}
|
||||
|
||||
// DomainUpdateOptions converts a Domain to DomainUpdateOptions for use in UpdateDomain
|
||||
type DomainUpdateOptions struct {
|
||||
// The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain.
|
||||
Domain string `json:"domain,omitempty"`
|
||||
|
||||
// If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave).
|
||||
// Enum:"master" "slave"
|
||||
Type DomainType `json:"type,omitempty"`
|
||||
|
||||
// Deprecated: The group this Domain belongs to. This is for display purposes only.
|
||||
Group string `json:"group,omitempty"`
|
||||
|
||||
// Used to control whether this Domain is currently being rendered.
|
||||
// Enum:"disabled" "active" "edit_mode" "has_errors"
|
||||
Status DomainStatus `json:"status,omitempty"`
|
||||
|
||||
// A description for this Domain. This is for display purposes only.
|
||||
Description string `json:"description,omitempty"`
|
||||
|
||||
// Start of Authority email address. This is required for master Domains.
|
||||
SOAEmail string `json:"soa_email,omitempty"`
|
||||
|
||||
// The interval, in seconds, at which a failed refresh should be retried.
|
||||
// Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
|
||||
RetrySec int `json:"retry_sec,omitempty"`
|
||||
|
||||
// The IP addresses representing the master DNS for this Domain.
|
||||
MasterIPs []string `json:"master_ips,omitempty"`
|
||||
|
||||
// The list of IPs that may perform a zone transfer for this Domain. This is potentially dangerous, and should be set to an empty list unless you intend to use it.
|
||||
AXfrIPs []string `json:"axfr_ips,omitempty"`
|
||||
|
||||
// An array of tags applied to this object. Tags are for organizational purposes only.
|
||||
Tags []string `json:"tags"`
|
||||
|
||||
// The amount of time in seconds that may pass before this Domain is no longer authoritative. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
|
||||
ExpireSec int `json:"expire_sec,omitempty"`
|
||||
|
||||
// The amount of time in seconds before this Domain should be refreshed. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
|
||||
RefreshSec int `json:"refresh_sec,omitempty"`
|
||||
|
||||
// "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
|
||||
TTLSec int `json:"ttl_sec,omitempty"`
|
||||
}
|
||||
|
||||
// DomainType constants start with DomainType and include Linode API Domain Type values
|
||||
type DomainType string
|
||||
|
||||
// DomainType constants reflect the DNS zone type of a Domain
|
||||
const (
|
||||
DomainTypeMaster DomainType = "master"
|
||||
DomainTypeSlave DomainType = "slave"
|
||||
)
|
||||
|
||||
// DomainStatus constants start with DomainStatus and include Linode API Domain Status values
|
||||
type DomainStatus string
|
||||
|
||||
// DomainStatus constants reflect the current status of a Domain
|
||||
const (
|
||||
DomainStatusDisabled DomainStatus = "disabled"
|
||||
DomainStatusActive DomainStatus = "active"
|
||||
DomainStatusEditMode DomainStatus = "edit_mode"
|
||||
DomainStatusHasErrors DomainStatus = "has_errors"
|
||||
)
|
||||
|
||||
// GetUpdateOptions converts a Domain to DomainUpdateOptions for use in UpdateDomain
|
||||
func (d Domain) GetUpdateOptions() (du DomainUpdateOptions) {
|
||||
du.Domain = d.Domain
|
||||
du.Type = d.Type
|
||||
du.Group = d.Group
|
||||
du.Status = d.Status
|
||||
du.Description = d.Description
|
||||
du.SOAEmail = d.SOAEmail
|
||||
du.RetrySec = d.RetrySec
|
||||
du.MasterIPs = d.MasterIPs
|
||||
du.AXfrIPs = d.AXfrIPs
|
||||
du.Tags = d.Tags
|
||||
du.ExpireSec = d.ExpireSec
|
||||
du.RefreshSec = d.RefreshSec
|
||||
du.TTLSec = d.TTLSec
|
||||
return
|
||||
}
|
||||
|
||||
// DomainsPagedResponse represents a paginated Domain API response
|
||||
type DomainsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Domain `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for Domain
|
||||
func (DomainsPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Domains.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends Domains when processing paginated Domain responses
|
||||
func (resp *DomainsPagedResponse) appendData(r *DomainsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListDomains lists Domains
|
||||
func (c *Client) ListDomains(ctx context.Context, opts *ListOptions) ([]Domain, error) {
|
||||
response := DomainsPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (d *Domain) fixDates() *Domain {
|
||||
return d
|
||||
}
|
||||
|
||||
// GetDomain gets the domain with the provided ID
|
||||
func (c *Client) GetDomain(ctx context.Context, id int) (*Domain, error) {
|
||||
e, err := c.Domains.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&Domain{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Domain).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateDomain creates a Domain
|
||||
func (c *Client) CreateDomain(ctx context.Context, domain DomainCreateOptions) (*Domain, error) {
|
||||
var body string
|
||||
e, err := c.Domains.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&Domain{})
|
||||
|
||||
bodyData, err := json.Marshal(domain)
|
||||
if err != nil {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
body = string(bodyData)
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Domain).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateDomain updates the Domain with the specified id
|
||||
func (c *Client) UpdateDomain(ctx context.Context, id int, domain DomainUpdateOptions) (*Domain, error) {
|
||||
var body string
|
||||
e, err := c.Domains.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
req := c.R(ctx).SetResult(&Domain{})
|
||||
|
||||
if bodyData, err := json.Marshal(domain); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Domain).fixDates(), nil
|
||||
}
|
||||
|
||||
// DeleteDomain deletes the Domain with the specified id
|
||||
func (c *Client) DeleteDomain(ctx context.Context, id int) error {
|
||||
e, err := c.Domains.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
LINODE_TOKEN=
|
||||
LINODE_DEBUG=0
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"gopkg.in/resty.v1"
|
||||
)
|
||||
|
||||
const (
|
||||
// ErrorFromString is the Code identifying Errors created by string types
|
||||
ErrorFromString = 1
|
||||
// ErrorFromError is the Code identifying Errors created by error types
|
||||
ErrorFromError = 2
|
||||
// ErrorFromStringer is the Code identifying Errors created by fmt.Stringer types
|
||||
ErrorFromStringer = 3
|
||||
)
|
||||
|
||||
// Error wraps the LinodeGo error with the relevant http.Response
|
||||
type Error struct {
|
||||
Response *http.Response
|
||||
Code int
|
||||
Message string
|
||||
}
|
||||
|
||||
// APIErrorReason is an individual invalid request message returned by the Linode API
|
||||
type APIErrorReason struct {
|
||||
Reason string `json:"reason"`
|
||||
Field string `json:"field"`
|
||||
}
|
||||
|
||||
func (r APIErrorReason) Error() string {
|
||||
if len(r.Field) == 0 {
|
||||
return r.Reason
|
||||
}
|
||||
return fmt.Sprintf("[%s] %s", r.Field, r.Reason)
|
||||
}
|
||||
|
||||
// APIError is the error-set returned by the Linode API when presented with an invalid request
|
||||
type APIError struct {
|
||||
Errors []APIErrorReason `json:"errors"`
|
||||
}
|
||||
|
||||
func coupleAPIErrors(r *resty.Response, err error) (*resty.Response, error) {
|
||||
if err != nil {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
if r.Error() != nil {
|
||||
apiError, ok := r.Error().(*APIError)
|
||||
if !ok || (ok && len(apiError.Errors) == 0) {
|
||||
return r, nil
|
||||
}
|
||||
return nil, NewError(r)
|
||||
}
|
||||
|
||||
return r, nil
|
||||
}
|
||||
|
||||
func (e APIError) Error() string {
|
||||
var x []string
|
||||
for _, msg := range e.Errors {
|
||||
x = append(x, msg.Error())
|
||||
}
|
||||
return strings.Join(x, "; ")
|
||||
}
|
||||
|
||||
func (g Error) Error() string {
|
||||
return fmt.Sprintf("[%03d] %s", g.Code, g.Message)
|
||||
}
|
||||
|
||||
// NewError creates a linodego.Error with a Code identifying the source err type,
|
||||
// - ErrorFromString (1) from a string
|
||||
// - ErrorFromError (2) for an error
|
||||
// - ErrorFromStringer (3) for a Stringer
|
||||
// - HTTP Status Codes (100-600) for a resty.Response object
|
||||
func NewError(err interface{}) *Error {
|
||||
if err == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
switch e := err.(type) {
|
||||
case *Error:
|
||||
return e
|
||||
case *resty.Response:
|
||||
apiError, ok := e.Error().(*APIError)
|
||||
|
||||
if !ok {
|
||||
log.Fatalln("Unexpected Resty Error Response")
|
||||
}
|
||||
|
||||
return &Error{
|
||||
Code: e.RawResponse.StatusCode,
|
||||
Message: apiError.Error(),
|
||||
Response: e.RawResponse,
|
||||
}
|
||||
case error:
|
||||
return &Error{Code: ErrorFromError, Message: e.Error()}
|
||||
case string:
|
||||
return &Error{Code: ErrorFromString, Message: e}
|
||||
case fmt.Stringer:
|
||||
return &Error{Code: ErrorFromStringer, Message: e.String()}
|
||||
default:
|
||||
log.Fatalln("Unsupported type to linodego.NewError")
|
||||
panic(err)
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,168 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Image represents a deployable Image object for use with Linode Instances
|
||||
type Image struct {
|
||||
CreatedStr string `json:"created"`
|
||||
ExpiryStr string `json:"expiry"`
|
||||
ID string `json:"id"`
|
||||
CreatedBy string `json:"created_by"`
|
||||
Label string `json:"label"`
|
||||
Description string `json:"description"`
|
||||
Type string `json:"type"`
|
||||
Vendor string `json:"vendor"`
|
||||
Size int `json:"size"`
|
||||
IsPublic bool `json:"is_public"`
|
||||
Deprecated bool `json:"deprecated"`
|
||||
|
||||
Created *time.Time `json:"-"`
|
||||
Expiry *time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// ImageCreateOptions fields are those accepted by CreateImage
|
||||
type ImageCreateOptions struct {
|
||||
DiskID int `json:"disk_id"`
|
||||
Label string `json:"label"`
|
||||
Description string `json:"description,omitempty"`
|
||||
}
|
||||
|
||||
// ImageUpdateOptions fields are those accepted by UpdateImage
|
||||
type ImageUpdateOptions struct {
|
||||
Label string `json:"label,omitempty"`
|
||||
Description *string `json:"description,omitempty"`
|
||||
}
|
||||
|
||||
func (i *Image) fixDates() *Image {
|
||||
i.Created, _ = parseDates(i.CreatedStr)
|
||||
|
||||
if len(i.ExpiryStr) > 0 {
|
||||
i.Expiry, _ = parseDates(i.ExpiryStr)
|
||||
} else {
|
||||
i.Expiry = nil
|
||||
}
|
||||
return i
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts an Image to ImageUpdateOptions for use in UpdateImage
|
||||
func (i Image) GetUpdateOptions() (iu ImageUpdateOptions) {
|
||||
iu.Label = i.Label
|
||||
iu.Description = copyString(&i.Description)
|
||||
return
|
||||
}
|
||||
|
||||
// ImagesPagedResponse represents a linode API response for listing of images
|
||||
type ImagesPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Image `json:"data"`
|
||||
}
|
||||
|
||||
func (ImagesPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Images.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
func (resp *ImagesPagedResponse) appendData(r *ImagesPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListImages lists Images
|
||||
func (c *Client) ListImages(ctx context.Context, opts *ListOptions) ([]Image, error) {
|
||||
response := ImagesPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
|
||||
}
|
||||
|
||||
// GetImage gets the Image with the provided ID
|
||||
func (c *Client) GetImage(ctx context.Context, id string) (*Image, error) {
|
||||
e, err := c.Images.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, id)
|
||||
r, err := coupleAPIErrors(c.Images.R(ctx).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Image).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateImage creates a Image
|
||||
func (c *Client) CreateImage(ctx context.Context, createOpts ImageCreateOptions) (*Image, error) {
|
||||
var body string
|
||||
e, err := c.Images.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&Image{})
|
||||
|
||||
if bodyData, err := json.Marshal(createOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Image).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateImage updates the Image with the specified id
|
||||
func (c *Client) UpdateImage(ctx context.Context, id string, updateOpts ImageUpdateOptions) (*Image, error) {
|
||||
var body string
|
||||
e, err := c.Images.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, id)
|
||||
|
||||
req := c.R(ctx).SetResult(&Image{})
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Image).fixDates(), nil
|
||||
}
|
||||
|
||||
// DeleteImage deletes the Image with the specified id
|
||||
func (c *Client) DeleteImage(ctx context.Context, id string) error {
|
||||
e, err := c.Images.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,246 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// InstanceConfig represents all of the settings that control the boot and run configuration of a Linode Instance
|
||||
type InstanceConfig struct {
|
||||
CreatedStr string `json:"created"`
|
||||
UpdatedStr string `json:"updated"`
|
||||
|
||||
ID int `json:"id"`
|
||||
Label string `json:"label"`
|
||||
Comments string `json:"comments"`
|
||||
Devices *InstanceConfigDeviceMap `json:"devices"`
|
||||
Helpers *InstanceConfigHelpers `json:"helpers"`
|
||||
MemoryLimit int `json:"memory_limit"`
|
||||
Kernel string `json:"kernel"`
|
||||
InitRD *int `json:"init_rd"`
|
||||
RootDevice string `json:"root_device"`
|
||||
RunLevel string `json:"run_level"`
|
||||
VirtMode string `json:"virt_mode"`
|
||||
Created *time.Time `json:"-"`
|
||||
Updated *time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// InstanceConfigDevice contains either the DiskID or VolumeID assigned to a Config Device
|
||||
type InstanceConfigDevice struct {
|
||||
DiskID int `json:"disk_id,omitempty"`
|
||||
VolumeID int `json:"volume_id,omitempty"`
|
||||
}
|
||||
|
||||
// InstanceConfigDeviceMap contains SDA-SDH InstanceConfigDevice settings
|
||||
type InstanceConfigDeviceMap struct {
|
||||
SDA *InstanceConfigDevice `json:"sda,omitempty"`
|
||||
SDB *InstanceConfigDevice `json:"sdb,omitempty"`
|
||||
SDC *InstanceConfigDevice `json:"sdc,omitempty"`
|
||||
SDD *InstanceConfigDevice `json:"sdd,omitempty"`
|
||||
SDE *InstanceConfigDevice `json:"sde,omitempty"`
|
||||
SDF *InstanceConfigDevice `json:"sdf,omitempty"`
|
||||
SDG *InstanceConfigDevice `json:"sdg,omitempty"`
|
||||
SDH *InstanceConfigDevice `json:"sdh,omitempty"`
|
||||
}
|
||||
|
||||
// InstanceConfigHelpers are Instance Config options that control Linux distribution specific tweaks
|
||||
type InstanceConfigHelpers struct {
|
||||
UpdateDBDisabled bool `json:"updatedb_disabled"`
|
||||
Distro bool `json:"distro"`
|
||||
ModulesDep bool `json:"modules_dep"`
|
||||
Network bool `json:"network"`
|
||||
DevTmpFsAutomount bool `json:"devtmpfs_automount"`
|
||||
}
|
||||
|
||||
// InstanceConfigsPagedResponse represents a paginated InstanceConfig API response
|
||||
type InstanceConfigsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []InstanceConfig `json:"data"`
|
||||
}
|
||||
|
||||
// InstanceConfigCreateOptions are InstanceConfig settings that can be used at creation
|
||||
type InstanceConfigCreateOptions struct {
|
||||
Label string `json:"label,omitempty"`
|
||||
Comments string `json:"comments,omitempty"`
|
||||
Devices InstanceConfigDeviceMap `json:"devices"`
|
||||
Helpers *InstanceConfigHelpers `json:"helpers,omitempty"`
|
||||
MemoryLimit int `json:"memory_limit,omitempty"`
|
||||
Kernel string `json:"kernel,omitempty"`
|
||||
InitRD int `json:"init_rd,omitempty"`
|
||||
RootDevice *string `json:"root_device,omitempty"`
|
||||
RunLevel string `json:"run_level,omitempty"`
|
||||
VirtMode string `json:"virt_mode,omitempty"`
|
||||
}
|
||||
|
||||
// InstanceConfigUpdateOptions are InstanceConfig settings that can be used in updates
|
||||
type InstanceConfigUpdateOptions struct {
|
||||
Label string `json:"label,omitempty"`
|
||||
Comments string `json:"comments"`
|
||||
Devices *InstanceConfigDeviceMap `json:"devices,omitempty"`
|
||||
Helpers *InstanceConfigHelpers `json:"helpers,omitempty"`
|
||||
// MemoryLimit 0 means unlimitted, this is not omitted
|
||||
MemoryLimit int `json:"memory_limit"`
|
||||
Kernel string `json:"kernel,omitempty"`
|
||||
// InitRD is nullable, permit the sending of null
|
||||
InitRD *int `json:"init_rd"`
|
||||
RootDevice string `json:"root_device,omitempty"`
|
||||
RunLevel string `json:"run_level,omitempty"`
|
||||
VirtMode string `json:"virt_mode,omitempty"`
|
||||
}
|
||||
|
||||
// GetCreateOptions converts a InstanceConfig to InstanceConfigCreateOptions for use in CreateInstanceConfig
|
||||
func (i InstanceConfig) GetCreateOptions() InstanceConfigCreateOptions {
|
||||
initrd := 0
|
||||
if i.InitRD != nil {
|
||||
initrd = *i.InitRD
|
||||
}
|
||||
return InstanceConfigCreateOptions{
|
||||
Label: i.Label,
|
||||
Comments: i.Comments,
|
||||
Devices: *i.Devices,
|
||||
Helpers: i.Helpers,
|
||||
MemoryLimit: i.MemoryLimit,
|
||||
Kernel: i.Kernel,
|
||||
InitRD: initrd,
|
||||
RootDevice: copyString(&i.RootDevice),
|
||||
RunLevel: i.RunLevel,
|
||||
VirtMode: i.VirtMode,
|
||||
}
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts a InstanceConfig to InstanceConfigUpdateOptions for use in UpdateInstanceConfig
|
||||
func (i InstanceConfig) GetUpdateOptions() InstanceConfigUpdateOptions {
|
||||
return InstanceConfigUpdateOptions{
|
||||
Label: i.Label,
|
||||
Comments: i.Comments,
|
||||
Devices: i.Devices,
|
||||
Helpers: i.Helpers,
|
||||
MemoryLimit: i.MemoryLimit,
|
||||
Kernel: i.Kernel,
|
||||
InitRD: copyInt(i.InitRD),
|
||||
RootDevice: i.RootDevice,
|
||||
RunLevel: i.RunLevel,
|
||||
VirtMode: i.VirtMode,
|
||||
}
|
||||
}
|
||||
|
||||
// endpointWithID gets the endpoint URL for InstanceConfigs of a given Instance
|
||||
func (InstanceConfigsPagedResponse) endpointWithID(c *Client, id int) string {
|
||||
endpoint, err := c.InstanceConfigs.endpointWithID(id)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends InstanceConfigs when processing paginated InstanceConfig responses
|
||||
func (resp *InstanceConfigsPagedResponse) appendData(r *InstanceConfigsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListInstanceConfigs lists InstanceConfigs
|
||||
func (c *Client) ListInstanceConfigs(ctx context.Context, linodeID int, opts *ListOptions) ([]InstanceConfig, error) {
|
||||
response := InstanceConfigsPagedResponse{}
|
||||
err := c.listHelperWithID(ctx, &response, linodeID, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (i *InstanceConfig) fixDates() *InstanceConfig {
|
||||
i.Created, _ = parseDates(i.CreatedStr)
|
||||
i.Updated, _ = parseDates(i.UpdatedStr)
|
||||
return i
|
||||
}
|
||||
|
||||
// GetInstanceConfig gets the template with the provided ID
|
||||
func (c *Client) GetInstanceConfig(ctx context.Context, linodeID int, configID int) (*InstanceConfig, error) {
|
||||
e, err := c.InstanceConfigs.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, configID)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&InstanceConfig{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*InstanceConfig).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateInstanceConfig creates a new InstanceConfig for the given Instance
|
||||
func (c *Client) CreateInstanceConfig(ctx context.Context, linodeID int, createOpts InstanceConfigCreateOptions) (*InstanceConfig, error) {
|
||||
var body string
|
||||
e, err := c.InstanceConfigs.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&InstanceConfig{})
|
||||
|
||||
if bodyData, err := json.Marshal(createOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return r.Result().(*InstanceConfig).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateInstanceConfig update an InstanceConfig for the given Instance
|
||||
func (c *Client) UpdateInstanceConfig(ctx context.Context, linodeID int, configID int, updateOpts InstanceConfigUpdateOptions) (*InstanceConfig, error) {
|
||||
var body string
|
||||
e, err := c.InstanceConfigs.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, configID)
|
||||
req := c.R(ctx).SetResult(&InstanceConfig{})
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return r.Result().(*InstanceConfig).fixDates(), nil
|
||||
}
|
||||
|
||||
// RenameInstanceConfig renames an InstanceConfig
|
||||
func (c *Client) RenameInstanceConfig(ctx context.Context, linodeID int, configID int, label string) (*InstanceConfig, error) {
|
||||
return c.UpdateInstanceConfig(ctx, linodeID, configID, InstanceConfigUpdateOptions{Label: label})
|
||||
}
|
||||
|
||||
// DeleteInstanceConfig deletes a Linode InstanceConfig
|
||||
func (c *Client) DeleteInstanceConfig(ctx context.Context, linodeID int, configID int) error {
|
||||
e, err := c.InstanceConfigs.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, configID)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,251 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// InstanceDisk represents an Instance Disk object
|
||||
type InstanceDisk struct {
|
||||
CreatedStr string `json:"created"`
|
||||
UpdatedStr string `json:"updated"`
|
||||
|
||||
ID int `json:"id"`
|
||||
Label string `json:"label"`
|
||||
Status DiskStatus `json:"status"`
|
||||
Size int `json:"size"`
|
||||
Filesystem DiskFilesystem `json:"filesystem"`
|
||||
Created time.Time `json:"-"`
|
||||
Updated time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// DiskFilesystem constants start with Filesystem and include Linode API Filesystems
|
||||
type DiskFilesystem string
|
||||
|
||||
// DiskFilesystem constants represent the filesystems types an Instance Disk may use
|
||||
const (
|
||||
FilesystemRaw DiskFilesystem = "raw"
|
||||
FilesystemSwap DiskFilesystem = "swap"
|
||||
FilesystemExt3 DiskFilesystem = "ext3"
|
||||
FilesystemExt4 DiskFilesystem = "ext4"
|
||||
FilesystemInitrd DiskFilesystem = "initrd"
|
||||
)
|
||||
|
||||
// DiskStatus constants have the prefix "Disk" and include Linode API Instance Disk Status
|
||||
type DiskStatus string
|
||||
|
||||
// DiskStatus constants represent the status values an Instance Disk may have
|
||||
const (
|
||||
DiskReady DiskStatus = "ready"
|
||||
DiskNotReady DiskStatus = "not ready"
|
||||
DiskDeleting DiskStatus = "deleting"
|
||||
)
|
||||
|
||||
// InstanceDisksPagedResponse represents a paginated InstanceDisk API response
|
||||
type InstanceDisksPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []InstanceDisk `json:"data"`
|
||||
}
|
||||
|
||||
// InstanceDiskCreateOptions are InstanceDisk settings that can be used at creation
|
||||
type InstanceDiskCreateOptions struct {
|
||||
Label string `json:"label"`
|
||||
Size int `json:"size"`
|
||||
|
||||
// Image is optional, but requires RootPass if provided
|
||||
Image string `json:"image,omitempty"`
|
||||
RootPass string `json:"root_pass,omitempty"`
|
||||
|
||||
Filesystem string `json:"filesystem,omitempty"`
|
||||
AuthorizedKeys []string `json:"authorized_keys,omitempty"`
|
||||
AuthorizedUsers []string `json:"authorized_users,omitempty"`
|
||||
ReadOnly bool `json:"read_only,omitempty"`
|
||||
StackscriptID int `json:"stackscript_id,omitempty"`
|
||||
StackscriptData map[string]string `json:"stackscript_data,omitempty"`
|
||||
}
|
||||
|
||||
// InstanceDiskUpdateOptions are InstanceDisk settings that can be used in updates
|
||||
type InstanceDiskUpdateOptions struct {
|
||||
Label string `json:"label"`
|
||||
ReadOnly bool `json:"read_only"`
|
||||
}
|
||||
|
||||
// endpointWithID gets the endpoint URL for InstanceDisks of a given Instance
|
||||
func (InstanceDisksPagedResponse) endpointWithID(c *Client, id int) string {
|
||||
endpoint, err := c.InstanceDisks.endpointWithID(id)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends InstanceDisks when processing paginated InstanceDisk responses
|
||||
func (resp *InstanceDisksPagedResponse) appendData(r *InstanceDisksPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListInstanceDisks lists InstanceDisks
|
||||
func (c *Client) ListInstanceDisks(ctx context.Context, linodeID int, opts *ListOptions) ([]InstanceDisk, error) {
|
||||
response := InstanceDisksPagedResponse{}
|
||||
err := c.listHelperWithID(ctx, &response, linodeID, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (v *InstanceDisk) fixDates() *InstanceDisk {
|
||||
if created, err := parseDates(v.CreatedStr); err == nil {
|
||||
v.Created = *created
|
||||
}
|
||||
if updated, err := parseDates(v.UpdatedStr); err == nil {
|
||||
v.Updated = *updated
|
||||
}
|
||||
return v
|
||||
}
|
||||
|
||||
// GetInstanceDisk gets the template with the provided ID
|
||||
func (c *Client) GetInstanceDisk(ctx context.Context, linodeID int, configID int) (*InstanceDisk, error) {
|
||||
e, err := c.InstanceDisks.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, configID)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&InstanceDisk{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*InstanceDisk).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateInstanceDisk creates a new InstanceDisk for the given Instance
|
||||
func (c *Client) CreateInstanceDisk(ctx context.Context, linodeID int, createOpts InstanceDiskCreateOptions) (*InstanceDisk, error) {
|
||||
var body string
|
||||
e, err := c.InstanceDisks.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&InstanceDisk{})
|
||||
|
||||
if bodyData, err := json.Marshal(createOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return r.Result().(*InstanceDisk).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateInstanceDisk creates a new InstanceDisk for the given Instance
|
||||
func (c *Client) UpdateInstanceDisk(ctx context.Context, linodeID int, diskID int, updateOpts InstanceDiskUpdateOptions) (*InstanceDisk, error) {
|
||||
var body string
|
||||
e, err := c.InstanceDisks.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, diskID)
|
||||
|
||||
req := c.R(ctx).SetResult(&InstanceDisk{})
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return r.Result().(*InstanceDisk).fixDates(), nil
|
||||
}
|
||||
|
||||
// RenameInstanceDisk renames an InstanceDisk
|
||||
func (c *Client) RenameInstanceDisk(ctx context.Context, linodeID int, diskID int, label string) (*InstanceDisk, error) {
|
||||
return c.UpdateInstanceDisk(ctx, linodeID, diskID, InstanceDiskUpdateOptions{Label: label})
|
||||
}
|
||||
|
||||
// ResizeInstanceDisk resizes the size of the Instance disk
|
||||
func (c *Client) ResizeInstanceDisk(ctx context.Context, linodeID int, diskID int, size int) error {
|
||||
var body string
|
||||
e, err := c.InstanceDisks.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d/resize", e, diskID)
|
||||
|
||||
req := c.R(ctx).SetResult(&InstanceDisk{})
|
||||
updateOpts := map[string]interface{}{
|
||||
"size": size,
|
||||
}
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return NewError(err)
|
||||
}
|
||||
|
||||
_, err = coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
// PasswordResetInstanceDisk resets the "root" account password on the Instance disk
|
||||
func (c *Client) PasswordResetInstanceDisk(ctx context.Context, linodeID int, diskID int, password string) error {
|
||||
var body string
|
||||
e, err := c.InstanceDisks.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d/password", e, diskID)
|
||||
|
||||
req := c.R(ctx).SetResult(&InstanceDisk{})
|
||||
updateOpts := map[string]interface{}{
|
||||
"password": password,
|
||||
}
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return NewError(err)
|
||||
}
|
||||
|
||||
_, err = coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
// DeleteInstanceDisk deletes a Linode Instance Disk
|
||||
func (c *Client) DeleteInstanceDisk(ctx context.Context, linodeID int, diskID int) error {
|
||||
e, err := c.InstanceDisks.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, diskID)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,106 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// InstanceIPAddressResponse contains the IPv4 and IPv6 details for an Instance
|
||||
type InstanceIPAddressResponse struct {
|
||||
IPv4 *InstanceIPv4Response `json:"ipv4"`
|
||||
IPv6 *InstanceIPv6Response `json:"ipv6"`
|
||||
}
|
||||
|
||||
// InstanceIPv4Response contains the details of all IPv4 addresses associated with an Instance
|
||||
type InstanceIPv4Response struct {
|
||||
Public []*InstanceIP `json:"public"`
|
||||
Private []*InstanceIP `json:"private"`
|
||||
Shared []*InstanceIP `json:"shared"`
|
||||
}
|
||||
|
||||
// InstanceIP represents an Instance IP with additional DNS and networking details
|
||||
type InstanceIP struct {
|
||||
Address string `json:"address"`
|
||||
Gateway string `json:"gateway"`
|
||||
SubnetMask string `json:"subnet_mask"`
|
||||
Prefix int `json:"prefix"`
|
||||
Type string `json:"type"`
|
||||
Public bool `json:"public"`
|
||||
RDNS string `json:"rdns"`
|
||||
LinodeID int `json:"linode_id"`
|
||||
Region string `json:"region"`
|
||||
}
|
||||
|
||||
// InstanceIPv6Response contains the IPv6 addresses and ranges for an Instance
|
||||
type InstanceIPv6Response struct {
|
||||
LinkLocal *InstanceIP `json:"link_local"`
|
||||
SLAAC *InstanceIP `json:"slaac"`
|
||||
Global []*IPv6Range `json:"global"`
|
||||
}
|
||||
|
||||
// IPv6Range represents a range of IPv6 addresses routed to a single Linode in a given Region
|
||||
type IPv6Range struct {
|
||||
Range string `json:"range"`
|
||||
Region string `json:"region"`
|
||||
}
|
||||
|
||||
// GetInstanceIPAddresses gets the IPAddresses for a Linode instance
|
||||
func (c *Client) GetInstanceIPAddresses(ctx context.Context, linodeID int) (*InstanceIPAddressResponse, error) {
|
||||
e, err := c.InstanceIPs.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&InstanceIPAddressResponse{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*InstanceIPAddressResponse), nil
|
||||
}
|
||||
|
||||
// GetInstanceIPAddress gets the IPAddress for a Linode instance matching a supplied IP address
|
||||
func (c *Client) GetInstanceIPAddress(ctx context.Context, linodeID int, ipaddress string) (*InstanceIP, error) {
|
||||
e, err := c.InstanceIPs.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, ipaddress)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&InstanceIP{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*InstanceIP), nil
|
||||
}
|
||||
|
||||
// AddInstanceIPAddress adds a public or private IP to a Linode instance
|
||||
func (c *Client) AddInstanceIPAddress(ctx context.Context, linodeID int, public bool) (*InstanceIP, error) {
|
||||
var body string
|
||||
e, err := c.InstanceIPs.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&InstanceIP{})
|
||||
|
||||
instanceipRequest := struct {
|
||||
Type string `json:"type"`
|
||||
Public bool `json:"public"`
|
||||
}{"ipv4", public}
|
||||
|
||||
if bodyData, err := json.Marshal(instanceipRequest); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetHeader("Content-Type", "application/json").
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return r.Result().(*InstanceIP), nil
|
||||
}
|
||||
|
|
@ -0,0 +1,188 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// InstanceBackupsResponse response struct for backup snapshot
|
||||
type InstanceBackupsResponse struct {
|
||||
Automatic []*InstanceSnapshot `json:"automatic"`
|
||||
Snapshot *InstanceBackupSnapshotResponse `json:"snapshot"`
|
||||
}
|
||||
|
||||
// InstanceBackupSnapshotResponse fields are those representing Instance Backup Snapshots
|
||||
type InstanceBackupSnapshotResponse struct {
|
||||
Current *InstanceSnapshot `json:"current"`
|
||||
InProgress *InstanceSnapshot `json:"in_progress"`
|
||||
}
|
||||
|
||||
// RestoreInstanceOptions fields are those accepted by InstanceRestore
|
||||
type RestoreInstanceOptions struct {
|
||||
LinodeID int `json:"linode_id"`
|
||||
Overwrite bool `json:"overwrite"`
|
||||
}
|
||||
|
||||
// InstanceSnapshot represents a linode backup snapshot
|
||||
type InstanceSnapshot struct {
|
||||
CreatedStr string `json:"created"`
|
||||
UpdatedStr string `json:"updated"`
|
||||
FinishedStr string `json:"finished"`
|
||||
|
||||
ID int `json:"id"`
|
||||
Label string `json:"label"`
|
||||
Status InstanceSnapshotStatus `json:"status"`
|
||||
Type string `json:"type"`
|
||||
Created *time.Time `json:"-"`
|
||||
Updated *time.Time `json:"-"`
|
||||
Finished *time.Time `json:"-"`
|
||||
Configs []string `json:"configs"`
|
||||
Disks []*InstanceSnapshotDisk `json:"disks"`
|
||||
}
|
||||
|
||||
// InstanceSnapshotDisk fields represent the source disk of a Snapshot
|
||||
type InstanceSnapshotDisk struct {
|
||||
Label string `json:"label"`
|
||||
Size int `json:"size"`
|
||||
Filesystem string `json:"filesystem"`
|
||||
}
|
||||
|
||||
// InstanceSnapshotStatus constants start with Snapshot and include Linode API Instance Backup Snapshot status values
|
||||
type InstanceSnapshotStatus string
|
||||
|
||||
// InstanceSnapshotStatus constants reflect the current status of an Instance Snapshot
|
||||
var (
|
||||
SnapshotPaused InstanceSnapshotStatus = "paused"
|
||||
SnapshotPending InstanceSnapshotStatus = "pending"
|
||||
SnapshotRunning InstanceSnapshotStatus = "running"
|
||||
SnapshotNeedsPostProcessing InstanceSnapshotStatus = "needsPostProcessing"
|
||||
SnapshotSuccessful InstanceSnapshotStatus = "successful"
|
||||
SnapshotFailed InstanceSnapshotStatus = "failed"
|
||||
SnapshotUserAborted InstanceSnapshotStatus = "userAborted"
|
||||
)
|
||||
|
||||
func (l *InstanceSnapshot) fixDates() *InstanceSnapshot {
|
||||
l.Created, _ = parseDates(l.CreatedStr)
|
||||
l.Updated, _ = parseDates(l.UpdatedStr)
|
||||
l.Finished, _ = parseDates(l.FinishedStr)
|
||||
return l
|
||||
}
|
||||
|
||||
// GetInstanceSnapshot gets the snapshot with the provided ID
|
||||
func (c *Client) GetInstanceSnapshot(ctx context.Context, linodeID int, snapshotID int) (*InstanceSnapshot, error) {
|
||||
e, err := c.InstanceSnapshots.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, snapshotID)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&InstanceSnapshot{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*InstanceSnapshot).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateInstanceSnapshot Creates or Replaces the snapshot Backup of a Linode. If a previous snapshot exists for this Linode, it will be deleted.
|
||||
func (c *Client) CreateInstanceSnapshot(ctx context.Context, linodeID int, label string) (*InstanceSnapshot, error) {
|
||||
o, err := json.Marshal(map[string]string{"label": label})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
body := string(o)
|
||||
e, err := c.InstanceSnapshots.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(c.R(ctx).
|
||||
SetBody(body).
|
||||
SetResult(&InstanceSnapshot{}).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return r.Result().(*InstanceSnapshot).fixDates(), nil
|
||||
}
|
||||
|
||||
// GetInstanceBackups gets the Instance's available Backups.
|
||||
// This is not called ListInstanceBackups because a single object is returned, matching the API response.
|
||||
func (c *Client) GetInstanceBackups(ctx context.Context, linodeID int) (*InstanceBackupsResponse, error) {
|
||||
e, err := c.InstanceSnapshots.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
r, err := coupleAPIErrors(c.R(ctx).
|
||||
SetResult(&InstanceBackupsResponse{}).
|
||||
Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*InstanceBackupsResponse).fixDates(), nil
|
||||
}
|
||||
|
||||
// EnableInstanceBackups Enables backups for the specified Linode.
|
||||
func (c *Client) EnableInstanceBackups(ctx context.Context, linodeID int) error {
|
||||
e, err := c.InstanceSnapshots.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/enable", e)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Post(e))
|
||||
return err
|
||||
}
|
||||
|
||||
// CancelInstanceBackups Cancels backups for the specified Linode.
|
||||
func (c *Client) CancelInstanceBackups(ctx context.Context, linodeID int) error {
|
||||
e, err := c.InstanceSnapshots.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/cancel", e)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Post(e))
|
||||
return err
|
||||
}
|
||||
|
||||
// RestoreInstanceBackup Restores a Linode's Backup to the specified Linode.
|
||||
func (c *Client) RestoreInstanceBackup(ctx context.Context, linodeID int, backupID int, opts RestoreInstanceOptions) error {
|
||||
o, err := json.Marshal(opts)
|
||||
if err != nil {
|
||||
return NewError(err)
|
||||
}
|
||||
body := string(o)
|
||||
e, err := c.InstanceSnapshots.endpointWithID(linodeID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d/restore", e, backupID)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).SetBody(body).Post(e))
|
||||
|
||||
return err
|
||||
|
||||
}
|
||||
|
||||
func (l *InstanceBackupSnapshotResponse) fixDates() *InstanceBackupSnapshotResponse {
|
||||
if l.Current != nil {
|
||||
l.Current.fixDates()
|
||||
}
|
||||
if l.InProgress != nil {
|
||||
l.InProgress.fixDates()
|
||||
}
|
||||
return l
|
||||
}
|
||||
|
||||
func (l *InstanceBackupsResponse) fixDates() *InstanceBackupsResponse {
|
||||
for i := range l.Automatic {
|
||||
l.Automatic[i].fixDates()
|
||||
}
|
||||
if l.Snapshot != nil {
|
||||
l.Snapshot.fixDates()
|
||||
}
|
||||
return l
|
||||
}
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
)
|
||||
|
||||
// InstanceVolumesPagedResponse represents a paginated InstanceVolume API response
|
||||
type InstanceVolumesPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Volume `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for InstanceVolume
|
||||
func (InstanceVolumesPagedResponse) endpointWithID(c *Client, id int) string {
|
||||
endpoint, err := c.InstanceVolumes.endpointWithID(id)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends InstanceVolumes when processing paginated InstanceVolume responses
|
||||
func (resp *InstanceVolumesPagedResponse) appendData(r *InstanceVolumesPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListInstanceVolumes lists InstanceVolumes
|
||||
func (c *Client) ListInstanceVolumes(ctx context.Context, linodeID int, opts *ListOptions) ([]Volume, error) {
|
||||
response := InstanceVolumesPagedResponse{}
|
||||
err := c.listHelperWithID(ctx, &response, linodeID, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
|
@ -0,0 +1,454 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net"
|
||||
"time"
|
||||
)
|
||||
|
||||
/*
|
||||
* https://developers.linode.com/v4/reference/endpoints/linode/instances
|
||||
*/
|
||||
|
||||
// InstanceStatus constants start with Instance and include Linode API Instance Status values
|
||||
type InstanceStatus string
|
||||
|
||||
// InstanceStatus constants reflect the current status of an Instance
|
||||
const (
|
||||
InstanceBooting InstanceStatus = "booting"
|
||||
InstanceRunning InstanceStatus = "running"
|
||||
InstanceOffline InstanceStatus = "offline"
|
||||
InstanceShuttingDown InstanceStatus = "shutting_down"
|
||||
InstanceRebooting InstanceStatus = "rebooting"
|
||||
InstanceProvisioning InstanceStatus = "provisioning"
|
||||
InstanceDeleting InstanceStatus = "deleting"
|
||||
InstanceMigrating InstanceStatus = "migrating"
|
||||
InstanceRebuilding InstanceStatus = "rebuilding"
|
||||
InstanceCloning InstanceStatus = "cloning"
|
||||
InstanceRestoring InstanceStatus = "restoring"
|
||||
InstanceResizing InstanceStatus = "resizing"
|
||||
)
|
||||
|
||||
// Instance represents a linode object
|
||||
type Instance struct {
|
||||
CreatedStr string `json:"created"`
|
||||
UpdatedStr string `json:"updated"`
|
||||
|
||||
ID int `json:"id"`
|
||||
Created *time.Time `json:"-"`
|
||||
Updated *time.Time `json:"-"`
|
||||
Region string `json:"region"`
|
||||
Alerts *InstanceAlert `json:"alerts"`
|
||||
Backups *InstanceBackup `json:"backups"`
|
||||
Image string `json:"image"`
|
||||
Group string `json:"group"`
|
||||
IPv4 []*net.IP `json:"ipv4"`
|
||||
IPv6 string `json:"ipv6"`
|
||||
Label string `json:"label"`
|
||||
Type string `json:"type"`
|
||||
Status InstanceStatus `json:"status"`
|
||||
Hypervisor string `json:"hypervisor"`
|
||||
Specs *InstanceSpec `json:"specs"`
|
||||
WatchdogEnabled bool `json:"watchdog_enabled"`
|
||||
Tags []string `json:"tags"`
|
||||
}
|
||||
|
||||
// InstanceSpec represents a linode spec
|
||||
type InstanceSpec struct {
|
||||
Disk int `json:"disk"`
|
||||
Memory int `json:"memory"`
|
||||
VCPUs int `json:"vcpus"`
|
||||
Transfer int `json:"transfer"`
|
||||
}
|
||||
|
||||
// InstanceAlert represents a metric alert
|
||||
type InstanceAlert struct {
|
||||
CPU int `json:"cpu"`
|
||||
IO int `json:"io"`
|
||||
NetworkIn int `json:"network_in"`
|
||||
NetworkOut int `json:"network_out"`
|
||||
TransferQuota int `json:"transfer_quota"`
|
||||
}
|
||||
|
||||
// InstanceBackup represents backup settings for an instance
|
||||
type InstanceBackup struct {
|
||||
Enabled bool `json:"enabled"`
|
||||
Schedule struct {
|
||||
Day string `json:"day,omitempty"`
|
||||
Window string `json:"window,omitempty"`
|
||||
}
|
||||
}
|
||||
|
||||
// InstanceCreateOptions require only Region and Type
|
||||
type InstanceCreateOptions struct {
|
||||
Region string `json:"region"`
|
||||
Type string `json:"type"`
|
||||
Label string `json:"label,omitempty"`
|
||||
Group string `json:"group,omitempty"`
|
||||
RootPass string `json:"root_pass,omitempty"`
|
||||
AuthorizedKeys []string `json:"authorized_keys,omitempty"`
|
||||
AuthorizedUsers []string `json:"authorized_users,omitempty"`
|
||||
StackScriptID int `json:"stackscript_id,omitempty"`
|
||||
StackScriptData map[string]string `json:"stackscript_data,omitempty"`
|
||||
BackupID int `json:"backup_id,omitempty"`
|
||||
Image string `json:"image,omitempty"`
|
||||
BackupsEnabled bool `json:"backups_enabled,omitempty"`
|
||||
PrivateIP bool `json:"private_ip,omitempty"`
|
||||
Tags []string `json:"tags,omitempty"`
|
||||
|
||||
// Creation fields that need to be set explicitly false, "", or 0 use pointers
|
||||
SwapSize *int `json:"swap_size,omitempty"`
|
||||
Booted *bool `json:"booted,omitempty"`
|
||||
}
|
||||
|
||||
// InstanceUpdateOptions is an options struct used when Updating an Instance
|
||||
type InstanceUpdateOptions struct {
|
||||
Label string `json:"label,omitempty"`
|
||||
Group string `json:"group,omitempty"`
|
||||
Backups *InstanceBackup `json:"backups,omitempty"`
|
||||
Alerts *InstanceAlert `json:"alerts,omitempty"`
|
||||
WatchdogEnabled *bool `json:"watchdog_enabled,omitempty"`
|
||||
Tags *[]string `json:"tags,omitempty"`
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts an Instance to InstanceUpdateOptions for use in UpdateInstance
|
||||
func (l *Instance) GetUpdateOptions() InstanceUpdateOptions {
|
||||
return InstanceUpdateOptions{
|
||||
Label: l.Label,
|
||||
Group: l.Group,
|
||||
Backups: l.Backups,
|
||||
Alerts: l.Alerts,
|
||||
WatchdogEnabled: &l.WatchdogEnabled,
|
||||
Tags: &l.Tags,
|
||||
}
|
||||
}
|
||||
|
||||
// InstanceCloneOptions is an options struct sent when Cloning an Instance
|
||||
type InstanceCloneOptions struct {
|
||||
Region string `json:"region,omitempty"`
|
||||
Type string `json:"type,omitempty"`
|
||||
|
||||
// LinodeID is an optional existing instance to use as the target of the clone
|
||||
LinodeID int `json:"linode_id,omitempty"`
|
||||
Label string `json:"label,omitempty"`
|
||||
Group string `json:"group,omitempty"`
|
||||
BackupsEnabled bool `json:"backups_enabled"`
|
||||
Disks []int `json:"disks,omitempty"`
|
||||
Configs []int `json:"configs,omitempty"`
|
||||
}
|
||||
|
||||
func (l *Instance) fixDates() *Instance {
|
||||
l.Created, _ = parseDates(l.CreatedStr)
|
||||
l.Updated, _ = parseDates(l.UpdatedStr)
|
||||
return l
|
||||
}
|
||||
|
||||
// InstancesPagedResponse represents a linode API response for listing
|
||||
type InstancesPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Instance `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for Instance
|
||||
func (InstancesPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Instances.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends Instances when processing paginated Instance responses
|
||||
func (resp *InstancesPagedResponse) appendData(r *InstancesPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListInstances lists linode instances
|
||||
func (c *Client) ListInstances(ctx context.Context, opts *ListOptions) ([]Instance, error) {
|
||||
response := InstancesPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// GetInstance gets the instance with the provided ID
|
||||
func (c *Client) GetInstance(ctx context.Context, linodeID int) (*Instance, error) {
|
||||
e, err := c.Instances.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, linodeID)
|
||||
r, err := coupleAPIErrors(c.R(ctx).
|
||||
SetResult(Instance{}).
|
||||
Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Instance).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateInstance creates a Linode instance
|
||||
func (c *Client) CreateInstance(ctx context.Context, instance InstanceCreateOptions) (*Instance, error) {
|
||||
var body string
|
||||
e, err := c.Instances.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&Instance{})
|
||||
|
||||
if bodyData, err := json.Marshal(instance); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Instance).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateInstance creates a Linode instance
|
||||
func (c *Client) UpdateInstance(ctx context.Context, id int, instance InstanceUpdateOptions) (*Instance, error) {
|
||||
var body string
|
||||
e, err := c.Instances.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
req := c.R(ctx).SetResult(&Instance{})
|
||||
|
||||
if bodyData, err := json.Marshal(instance); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Instance).fixDates(), nil
|
||||
}
|
||||
|
||||
// RenameInstance renames an Instance
|
||||
func (c *Client) RenameInstance(ctx context.Context, linodeID int, label string) (*Instance, error) {
|
||||
return c.UpdateInstance(ctx, linodeID, InstanceUpdateOptions{Label: label})
|
||||
}
|
||||
|
||||
// DeleteInstance deletes a Linode instance
|
||||
func (c *Client) DeleteInstance(ctx context.Context, id int) error {
|
||||
e, err := c.Instances.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
||||
// BootInstance will boot a Linode instance
|
||||
// A configID of 0 will cause Linode to choose the last/best config
|
||||
func (c *Client) BootInstance(ctx context.Context, id int, configID int) error {
|
||||
bodyStr := ""
|
||||
|
||||
if configID != 0 {
|
||||
bodyMap := map[string]int{"config_id": configID}
|
||||
bodyJSON, err := json.Marshal(bodyMap)
|
||||
if err != nil {
|
||||
return NewError(err)
|
||||
}
|
||||
bodyStr = string(bodyJSON)
|
||||
}
|
||||
|
||||
e, err := c.Instances.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
e = fmt.Sprintf("%s/%d/boot", e, id)
|
||||
_, err = coupleAPIErrors(c.R(ctx).
|
||||
SetBody(bodyStr).
|
||||
Post(e))
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
// CloneInstance clone an existing Instances Disks and Configuration profiles to another Linode Instance
|
||||
func (c *Client) CloneInstance(ctx context.Context, id int, options InstanceCloneOptions) (*Instance, error) {
|
||||
var body string
|
||||
e, err := c.Instances.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d/clone", e, id)
|
||||
|
||||
req := c.R(ctx).SetResult(&Instance{})
|
||||
|
||||
if bodyData, err := json.Marshal(options); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return r.Result().(*Instance).fixDates(), nil
|
||||
}
|
||||
|
||||
// RebootInstance reboots a Linode instance
|
||||
// A configID of 0 will cause Linode to choose the last/best config
|
||||
func (c *Client) RebootInstance(ctx context.Context, id int, configID int) error {
|
||||
bodyStr := "{}"
|
||||
|
||||
if configID != 0 {
|
||||
bodyMap := map[string]int{"config_id": configID}
|
||||
bodyJSON, err := json.Marshal(bodyMap)
|
||||
if err != nil {
|
||||
return NewError(err)
|
||||
}
|
||||
bodyStr = string(bodyJSON)
|
||||
}
|
||||
|
||||
e, err := c.Instances.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
e = fmt.Sprintf("%s/%d/reboot", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).
|
||||
SetBody(bodyStr).
|
||||
Post(e))
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
// RebuildInstanceOptions is a struct representing the options to send to the rebuild linode endpoint
|
||||
type RebuildInstanceOptions struct {
|
||||
Image string `json:"image"`
|
||||
RootPass string `json:"root_pass"`
|
||||
AuthorizedKeys []string `json:"authorized_keys"`
|
||||
AuthorizedUsers []string `json:"authorized_users"`
|
||||
StackscriptID int `json:"stackscript_id"`
|
||||
StackscriptData map[string]string `json:"stackscript_data"`
|
||||
Booted bool `json:"booted"`
|
||||
}
|
||||
|
||||
// RebuildInstance Deletes all Disks and Configs on this Linode,
|
||||
// then deploys a new Image to this Linode with the given attributes.
|
||||
func (c *Client) RebuildInstance(ctx context.Context, id int, opts RebuildInstanceOptions) (*Instance, error) {
|
||||
o, err := json.Marshal(opts)
|
||||
if err != nil {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
b := string(o)
|
||||
e, err := c.Instances.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d/rebuild", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).
|
||||
SetBody(b).
|
||||
SetResult(&Instance{}).
|
||||
Post(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Instance).fixDates(), nil
|
||||
}
|
||||
|
||||
// RescueInstanceOptions fields are those accepted by RescueInstance
|
||||
type RescueInstanceOptions struct {
|
||||
Devices InstanceConfigDeviceMap `json:"devices"`
|
||||
}
|
||||
|
||||
// RescueInstance reboots an instance into a safe environment for performing many system recovery and disk management tasks.
|
||||
// Rescue Mode is based on the Finnix recovery distribution, a self-contained and bootable Linux distribution.
|
||||
// You can also use Rescue Mode for tasks other than disaster recovery, such as formatting disks to use different filesystems,
|
||||
// copying data between disks, and downloading files from a disk via SSH and SFTP.
|
||||
func (c *Client) RescueInstance(ctx context.Context, id int, opts RescueInstanceOptions) error {
|
||||
o, err := json.Marshal(opts)
|
||||
if err != nil {
|
||||
return NewError(err)
|
||||
}
|
||||
b := string(o)
|
||||
e, err := c.Instances.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d/rescue", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).
|
||||
SetBody(b).
|
||||
Post(e))
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
// ResizeInstance resizes an instance to new Linode type
|
||||
func (c *Client) ResizeInstance(ctx context.Context, id int, linodeType string) error {
|
||||
body := fmt.Sprintf("{\"type\":\"%s\"}", linodeType)
|
||||
|
||||
e, err := c.Instances.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d/resize", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
// ShutdownInstance - Shutdown an instance
|
||||
func (c *Client) ShutdownInstance(ctx context.Context, id int) error {
|
||||
return c.simpleInstanceAction(ctx, "shutdown", id)
|
||||
}
|
||||
|
||||
// MutateInstance Upgrades a Linode to its next generation.
|
||||
func (c *Client) MutateInstance(ctx context.Context, id int) error {
|
||||
return c.simpleInstanceAction(ctx, "mutate", id)
|
||||
}
|
||||
|
||||
// MigrateInstance - Migrate an instance
|
||||
func (c *Client) MigrateInstance(ctx context.Context, id int) error {
|
||||
return c.simpleInstanceAction(ctx, "migrate", id)
|
||||
}
|
||||
|
||||
// simpleInstanceAction is a helper for Instance actions that take no parameters
|
||||
// and return empty responses `{}` unless they return a standard error
|
||||
func (c *Client) simpleInstanceAction(ctx context.Context, action string, id int) error {
|
||||
e, err := c.Instances.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d/%s", e, id, action)
|
||||
_, err = coupleAPIErrors(c.R(ctx).Post(e))
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// LinodeKernel represents a Linode Instance kernel object
|
||||
type LinodeKernel struct {
|
||||
ID string `json:"id"`
|
||||
Label string `json:"label"`
|
||||
Version string `json:"version"`
|
||||
Architecture string `json:"architecture"`
|
||||
KVM bool `json:"kvm"`
|
||||
XEN bool `json:"xen"`
|
||||
PVOPS bool `json:"pvops"`
|
||||
}
|
||||
|
||||
// LinodeKernelsPagedResponse represents a Linode kernels API response for listing
|
||||
type LinodeKernelsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []LinodeKernel `json:"data"`
|
||||
}
|
||||
|
||||
// ListKernels lists linode kernels
|
||||
func (c *Client) ListKernels(ctx context.Context, opts *ListOptions) ([]LinodeKernel, error) {
|
||||
response := LinodeKernelsPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
func (LinodeKernelsPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Kernels.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
func (resp *LinodeKernelsPagedResponse) appendData(r *LinodeKernelsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// GetKernel gets the kernel with the provided ID
|
||||
func (c *Client) GetKernel(ctx context.Context, kernelID string) (*LinodeKernel, error) {
|
||||
e, err := c.Kernels.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, kernelID)
|
||||
r, err := c.R(ctx).
|
||||
SetResult(&LinodeKernel{}).
|
||||
Get(e)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*LinodeKernel), nil
|
||||
}
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// LongviewClient represents a LongviewClient object
|
||||
type LongviewClient struct {
|
||||
ID int `json:"id"`
|
||||
// UpdatedStr string `json:"updated"`
|
||||
// Updated *time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// LongviewClientsPagedResponse represents a paginated LongviewClient API response
|
||||
type LongviewClientsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []LongviewClient `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for LongviewClient
|
||||
func (LongviewClientsPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.LongviewClients.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends LongviewClients when processing paginated LongviewClient responses
|
||||
func (resp *LongviewClientsPagedResponse) appendData(r *LongviewClientsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListLongviewClients lists LongviewClients
|
||||
func (c *Client) ListLongviewClients(ctx context.Context, opts *ListOptions) ([]LongviewClient, error) {
|
||||
response := LongviewClientsPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (v *LongviewClient) fixDates() *LongviewClient {
|
||||
// v.Created, _ = parseDates(v.CreatedStr)
|
||||
// v.Updated, _ = parseDates(v.UpdatedStr)
|
||||
return v
|
||||
}
|
||||
|
||||
// GetLongviewClient gets the template with the provided ID
|
||||
func (c *Client) GetLongviewClient(ctx context.Context, id string) (*LongviewClient, error) {
|
||||
e, err := c.LongviewClients.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, id)
|
||||
r, err := c.R(ctx).SetResult(&LongviewClient{}).Get(e)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*LongviewClient).fixDates(), nil
|
||||
}
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// LongviewSubscription represents a LongviewSubscription object
|
||||
type LongviewSubscription struct {
|
||||
ID string `json:"id"`
|
||||
Label string `json:"label"`
|
||||
ClientsIncluded int `json:"clients_included"`
|
||||
Price *LinodePrice `json:"price"`
|
||||
// UpdatedStr string `json:"updated"`
|
||||
// Updated *time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// LongviewSubscriptionsPagedResponse represents a paginated LongviewSubscription API response
|
||||
type LongviewSubscriptionsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []LongviewSubscription `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for LongviewSubscription
|
||||
func (LongviewSubscriptionsPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.LongviewSubscriptions.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends LongviewSubscriptions when processing paginated LongviewSubscription responses
|
||||
func (resp *LongviewSubscriptionsPagedResponse) appendData(r *LongviewSubscriptionsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListLongviewSubscriptions lists LongviewSubscriptions
|
||||
func (c *Client) ListLongviewSubscriptions(ctx context.Context, opts *ListOptions) ([]LongviewSubscription, error) {
|
||||
response := LongviewSubscriptionsPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (v *LongviewSubscription) fixDates() *LongviewSubscription {
|
||||
// v.Created, _ = parseDates(v.CreatedStr)
|
||||
// v.Updated, _ = parseDates(v.UpdatedStr)
|
||||
return v
|
||||
}
|
||||
|
||||
// GetLongviewSubscription gets the template with the provided ID
|
||||
func (c *Client) GetLongviewSubscription(ctx context.Context, id string) (*LongviewSubscription, error) {
|
||||
e, err := c.LongviewSubscriptions.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, id)
|
||||
r, err := c.R(ctx).SetResult(&LongviewSubscription{}).Get(e)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*LongviewSubscription).fixDates(), nil
|
||||
}
|
||||
|
|
@ -0,0 +1 @@
|
|||
package linodego
|
||||
|
|
@ -0,0 +1,90 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// IPAddressesPagedResponse represents a paginated IPAddress API response
|
||||
type IPAddressesPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []InstanceIP `json:"data"`
|
||||
}
|
||||
|
||||
// IPAddressUpdateOptions fields are those accepted by UpdateToken
|
||||
type IPAddressUpdateOptions struct {
|
||||
// The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if set to nil.
|
||||
RDNS *string `json:"rdns"`
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts a IPAddress to IPAddressUpdateOptions for use in UpdateIPAddress
|
||||
func (i InstanceIP) GetUpdateOptions() (o IPAddressUpdateOptions) {
|
||||
o.RDNS = copyString(&i.RDNS)
|
||||
return
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for IPAddress
|
||||
func (IPAddressesPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.IPAddresses.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends IPAddresses when processing paginated InstanceIPAddress responses
|
||||
func (resp *IPAddressesPagedResponse) appendData(r *IPAddressesPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListIPAddresses lists IPAddresses
|
||||
func (c *Client) ListIPAddresses(ctx context.Context, opts *ListOptions) ([]InstanceIP, error) {
|
||||
response := IPAddressesPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// GetIPAddress gets the template with the provided ID
|
||||
func (c *Client) GetIPAddress(ctx context.Context, id string) (*InstanceIP, error) {
|
||||
e, err := c.IPAddresses.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&InstanceIP{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*InstanceIP), nil
|
||||
}
|
||||
|
||||
// UpdateIPAddress updates the IPAddress with the specified id
|
||||
func (c *Client) UpdateIPAddress(ctx context.Context, id string, updateOpts IPAddressUpdateOptions) (*InstanceIP, error) {
|
||||
var body string
|
||||
e, err := c.IPAddresses.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, id)
|
||||
|
||||
req := c.R(ctx).SetResult(&InstanceIP{})
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*InstanceIP), nil
|
||||
}
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// IPv6PoolsPagedResponse represents a paginated IPv6Pool API response
|
||||
type IPv6PoolsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []IPv6Range `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for IPv6Pool
|
||||
func (IPv6PoolsPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.IPv6Pools.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends IPv6Pools when processing paginated IPv6Pool responses
|
||||
func (resp *IPv6PoolsPagedResponse) appendData(r *IPv6PoolsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListIPv6Pools lists IPv6Pools
|
||||
func (c *Client) ListIPv6Pools(ctx context.Context, opts *ListOptions) ([]IPv6Range, error) {
|
||||
response := IPv6PoolsPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// GetIPv6Pool gets the template with the provided ID
|
||||
func (c *Client) GetIPv6Pool(ctx context.Context, id string) (*IPv6Range, error) {
|
||||
e, err := c.IPv6Pools.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&IPv6Range{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*IPv6Range), nil
|
||||
}
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// IPv6RangesPagedResponse represents a paginated IPv6Range API response
|
||||
type IPv6RangesPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []IPv6Range `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for IPv6Range
|
||||
func (IPv6RangesPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.IPv6Ranges.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends IPv6Ranges when processing paginated IPv6Range responses
|
||||
func (resp *IPv6RangesPagedResponse) appendData(r *IPv6RangesPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListIPv6Ranges lists IPv6Ranges
|
||||
func (c *Client) ListIPv6Ranges(ctx context.Context, opts *ListOptions) ([]IPv6Range, error) {
|
||||
response := IPv6RangesPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// GetIPv6Range gets the template with the provided ID
|
||||
func (c *Client) GetIPv6Range(ctx context.Context, id string) (*IPv6Range, error) {
|
||||
e, err := c.IPv6Ranges.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&IPv6Range{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*IPv6Range), nil
|
||||
}
|
||||
|
|
@ -0,0 +1,199 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// NodeBalancer represents a NodeBalancer object
|
||||
type NodeBalancer struct {
|
||||
CreatedStr string `json:"created"`
|
||||
UpdatedStr string `json:"updated"`
|
||||
// This NodeBalancer's unique ID.
|
||||
ID int `json:"id"`
|
||||
// This NodeBalancer's label. These must be unique on your Account.
|
||||
Label *string `json:"label"`
|
||||
// The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.
|
||||
Region string `json:"region"`
|
||||
// This NodeBalancer's hostname, ending with .nodebalancer.linode.com
|
||||
Hostname *string `json:"hostname"`
|
||||
// This NodeBalancer's public IPv4 address.
|
||||
IPv4 *string `json:"ipv4"`
|
||||
// This NodeBalancer's public IPv6 address.
|
||||
IPv6 *string `json:"ipv6"`
|
||||
// Throttle connections per second (0-20). Set to 0 (zero) to disable throttling.
|
||||
ClientConnThrottle int `json:"client_conn_throttle"`
|
||||
// Information about the amount of transfer this NodeBalancer has had so far this month.
|
||||
Transfer NodeBalancerTransfer `json:"transfer"`
|
||||
|
||||
// An array of tags applied to this object. Tags are for organizational purposes only.
|
||||
Tags []string `json:"tags"`
|
||||
|
||||
Created *time.Time `json:"-"`
|
||||
Updated *time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// NodeBalancerTransfer contains information about the amount of transfer a NodeBalancer has had in the current month
|
||||
type NodeBalancerTransfer struct {
|
||||
// The total transfer, in MB, used by this NodeBalancer this month.
|
||||
Total *float64 `json:"total"`
|
||||
// The total inbound transfer, in MB, used for this NodeBalancer this month.
|
||||
Out *float64 `json:"out"`
|
||||
// The total outbound transfer, in MB, used for this NodeBalancer this month.
|
||||
In *float64 `json:"in"`
|
||||
}
|
||||
|
||||
// NodeBalancerCreateOptions are the options permitted for CreateNodeBalancer
|
||||
type NodeBalancerCreateOptions struct {
|
||||
Label *string `json:"label,omitempty"`
|
||||
Region string `json:"region,omitempty"`
|
||||
ClientConnThrottle *int `json:"client_conn_throttle,omitempty"`
|
||||
Configs []*NodeBalancerConfigCreateOptions `json:"configs,omitempty"`
|
||||
Tags []string `json:"tags"`
|
||||
}
|
||||
|
||||
// NodeBalancerUpdateOptions are the options permitted for UpdateNodeBalancer
|
||||
type NodeBalancerUpdateOptions struct {
|
||||
Label *string `json:"label,omitempty"`
|
||||
ClientConnThrottle *int `json:"client_conn_throttle,omitempty"`
|
||||
Tags *[]string `json:"tags,omitempty"`
|
||||
}
|
||||
|
||||
// GetCreateOptions converts a NodeBalancer to NodeBalancerCreateOptions for use in CreateNodeBalancer
|
||||
func (i NodeBalancer) GetCreateOptions() NodeBalancerCreateOptions {
|
||||
return NodeBalancerCreateOptions{
|
||||
Label: i.Label,
|
||||
Region: i.Region,
|
||||
ClientConnThrottle: &i.ClientConnThrottle,
|
||||
Tags: i.Tags,
|
||||
}
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts a NodeBalancer to NodeBalancerUpdateOptions for use in UpdateNodeBalancer
|
||||
func (i NodeBalancer) GetUpdateOptions() NodeBalancerUpdateOptions {
|
||||
return NodeBalancerUpdateOptions{
|
||||
Label: i.Label,
|
||||
ClientConnThrottle: &i.ClientConnThrottle,
|
||||
Tags: &i.Tags,
|
||||
}
|
||||
}
|
||||
|
||||
// NodeBalancersPagedResponse represents a paginated NodeBalancer API response
|
||||
type NodeBalancersPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []NodeBalancer `json:"data"`
|
||||
}
|
||||
|
||||
func (NodeBalancersPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.NodeBalancers.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
func (resp *NodeBalancersPagedResponse) appendData(r *NodeBalancersPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListNodeBalancers lists NodeBalancers
|
||||
func (c *Client) ListNodeBalancers(ctx context.Context, opts *ListOptions) ([]NodeBalancer, error) {
|
||||
response := NodeBalancersPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (i *NodeBalancer) fixDates() *NodeBalancer {
|
||||
i.Created, _ = parseDates(i.CreatedStr)
|
||||
i.Updated, _ = parseDates(i.UpdatedStr)
|
||||
return i
|
||||
}
|
||||
|
||||
// GetNodeBalancer gets the NodeBalancer with the provided ID
|
||||
func (c *Client) GetNodeBalancer(ctx context.Context, id int) (*NodeBalancer, error) {
|
||||
e, err := c.NodeBalancers.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).
|
||||
SetResult(&NodeBalancer{}).
|
||||
Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*NodeBalancer).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateNodeBalancer creates a NodeBalancer
|
||||
func (c *Client) CreateNodeBalancer(ctx context.Context, nodebalancer NodeBalancerCreateOptions) (*NodeBalancer, error) {
|
||||
var body string
|
||||
e, err := c.NodeBalancers.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&NodeBalancer{})
|
||||
|
||||
if bodyData, err := json.Marshal(nodebalancer); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetHeader("Content-Type", "application/json").
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*NodeBalancer).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateNodeBalancer updates the NodeBalancer with the specified id
|
||||
func (c *Client) UpdateNodeBalancer(ctx context.Context, id int, updateOpts NodeBalancerUpdateOptions) (*NodeBalancer, error) {
|
||||
var body string
|
||||
e, err := c.NodeBalancers.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
req := c.R(ctx).SetResult(&NodeBalancer{})
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*NodeBalancer).fixDates(), nil
|
||||
}
|
||||
|
||||
// DeleteNodeBalancer deletes the NodeBalancer with the specified id
|
||||
func (c *Client) DeleteNodeBalancer(ctx context.Context, id int) error {
|
||||
e, err := c.NodeBalancers.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,186 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// NodeBalancerNode objects represent a backend that can accept traffic for a NodeBalancer Config
|
||||
type NodeBalancerNode struct {
|
||||
ID int `json:"id"`
|
||||
Address string `json:"address"`
|
||||
Label string `json:"label"`
|
||||
Status string `json:"status"`
|
||||
Weight int `json:"weight"`
|
||||
Mode NodeMode `json:"mode"`
|
||||
ConfigID int `json:"config_id"`
|
||||
NodeBalancerID int `json:"nodebalancer_id"`
|
||||
}
|
||||
|
||||
// NodeMode is the mode a NodeBalancer should use when sending traffic to a NodeBalancer Node
|
||||
type NodeMode string
|
||||
|
||||
var (
|
||||
// ModeAccept is the NodeMode indicating a NodeBalancer Node is accepting traffic
|
||||
ModeAccept NodeMode = "accept"
|
||||
|
||||
// ModeReject is the NodeMode indicating a NodeBalancer Node is not receiving traffic
|
||||
ModeReject NodeMode = "reject"
|
||||
|
||||
// ModeDrain is the NodeMode indicating a NodeBalancer Node is not receiving new traffic, but may continue receiving traffic from pinned connections
|
||||
ModeDrain NodeMode = "drain"
|
||||
)
|
||||
|
||||
// NodeBalancerNodeCreateOptions fields are those accepted by CreateNodeBalancerNode
|
||||
type NodeBalancerNodeCreateOptions struct {
|
||||
Address string `json:"address"`
|
||||
Label string `json:"label"`
|
||||
Weight int `json:"weight,omitempty"`
|
||||
Mode NodeMode `json:"mode,omitempty"`
|
||||
}
|
||||
|
||||
// NodeBalancerNodeUpdateOptions fields are those accepted by UpdateNodeBalancerNode
|
||||
type NodeBalancerNodeUpdateOptions struct {
|
||||
Address string `json:"address,omitempty"`
|
||||
Label string `json:"label,omitempty"`
|
||||
Weight int `json:"weight,omitempty"`
|
||||
Mode NodeMode `json:"mode,omitempty"`
|
||||
}
|
||||
|
||||
// GetCreateOptions converts a NodeBalancerNode to NodeBalancerNodeCreateOptions for use in CreateNodeBalancerNode
|
||||
func (i NodeBalancerNode) GetCreateOptions() NodeBalancerNodeCreateOptions {
|
||||
return NodeBalancerNodeCreateOptions{
|
||||
Address: i.Address,
|
||||
Label: i.Label,
|
||||
Weight: i.Weight,
|
||||
Mode: i.Mode,
|
||||
}
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts a NodeBalancerNode to NodeBalancerNodeUpdateOptions for use in UpdateNodeBalancerNode
|
||||
func (i NodeBalancerNode) GetUpdateOptions() NodeBalancerNodeUpdateOptions {
|
||||
return NodeBalancerNodeUpdateOptions{
|
||||
Address: i.Address,
|
||||
Label: i.Label,
|
||||
Weight: i.Weight,
|
||||
Mode: i.Mode,
|
||||
}
|
||||
}
|
||||
|
||||
// NodeBalancerNodesPagedResponse represents a paginated NodeBalancerNode API response
|
||||
type NodeBalancerNodesPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []NodeBalancerNode `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for NodeBalancerNode
|
||||
func (NodeBalancerNodesPagedResponse) endpointWithTwoIDs(c *Client, nodebalancerID int, configID int) string {
|
||||
endpoint, err := c.NodeBalancerNodes.endpointWithID(nodebalancerID, configID)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends NodeBalancerNodes when processing paginated NodeBalancerNode responses
|
||||
func (resp *NodeBalancerNodesPagedResponse) appendData(r *NodeBalancerNodesPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListNodeBalancerNodes lists NodeBalancerNodes
|
||||
func (c *Client) ListNodeBalancerNodes(ctx context.Context, nodebalancerID int, configID int, opts *ListOptions) ([]NodeBalancerNode, error) {
|
||||
response := NodeBalancerNodesPagedResponse{}
|
||||
err := c.listHelperWithTwoIDs(ctx, &response, nodebalancerID, configID, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (i *NodeBalancerNode) fixDates() *NodeBalancerNode {
|
||||
return i
|
||||
}
|
||||
|
||||
// GetNodeBalancerNode gets the template with the provided ID
|
||||
func (c *Client) GetNodeBalancerNode(ctx context.Context, nodebalancerID int, configID int, nodeID int) (*NodeBalancerNode, error) {
|
||||
e, err := c.NodeBalancerNodes.endpointWithID(nodebalancerID, configID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, nodeID)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&NodeBalancerNode{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*NodeBalancerNode).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateNodeBalancerNode creates a NodeBalancerNode
|
||||
func (c *Client) CreateNodeBalancerNode(ctx context.Context, nodebalancerID int, configID int, createOpts NodeBalancerNodeCreateOptions) (*NodeBalancerNode, error) {
|
||||
var body string
|
||||
e, err := c.NodeBalancerNodes.endpointWithID(nodebalancerID, configID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&NodeBalancerNode{})
|
||||
|
||||
if bodyData, err := json.Marshal(createOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*NodeBalancerNode).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateNodeBalancerNode updates the NodeBalancerNode with the specified id
|
||||
func (c *Client) UpdateNodeBalancerNode(ctx context.Context, nodebalancerID int, configID int, nodeID int, updateOpts NodeBalancerNodeUpdateOptions) (*NodeBalancerNode, error) {
|
||||
var body string
|
||||
e, err := c.NodeBalancerNodes.endpointWithID(nodebalancerID, configID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, nodeID)
|
||||
|
||||
req := c.R(ctx).SetResult(&NodeBalancerNode{})
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*NodeBalancerNode).fixDates(), nil
|
||||
}
|
||||
|
||||
// DeleteNodeBalancerNode deletes the NodeBalancerNode with the specified id
|
||||
func (c *Client) DeleteNodeBalancerNode(ctx context.Context, nodebalancerID int, configID int, nodeID int) error {
|
||||
e, err := c.NodeBalancerNodes.endpointWithID(nodebalancerID, configID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, nodeID)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,334 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// NodeBalancerConfig objects allow a NodeBalancer to accept traffic on a new port
|
||||
type NodeBalancerConfig struct {
|
||||
ID int `json:"id"`
|
||||
Port int `json:"port"`
|
||||
Protocol ConfigProtocol `json:"protocol"`
|
||||
Algorithm ConfigAlgorithm `json:"algorithm"`
|
||||
Stickiness ConfigStickiness `json:"stickiness"`
|
||||
Check ConfigCheck `json:"check"`
|
||||
CheckInterval int `json:"check_interval"`
|
||||
CheckAttempts int `json:"check_attempts"`
|
||||
CheckPath string `json:"check_path"`
|
||||
CheckBody string `json:"check_body"`
|
||||
CheckPassive bool `json:"check_passive"`
|
||||
CheckTimeout int `json:"check_timeout"`
|
||||
CipherSuite ConfigCipher `json:"cipher_suite"`
|
||||
NodeBalancerID int `json:"nodebalancer_id"`
|
||||
SSLCommonName string `json:"ssl_commonname"`
|
||||
SSLFingerprint string `json:"ssl_fingerprint"`
|
||||
SSLCert string `json:"ssl_cert"`
|
||||
SSLKey string `json:"ssl_key"`
|
||||
NodesStatus *NodeBalancerNodeStatus `json:"nodes_status"`
|
||||
}
|
||||
|
||||
// ConfigAlgorithm constants start with Algorithm and include Linode API NodeBalancer Config Algorithms
|
||||
type ConfigAlgorithm string
|
||||
|
||||
// ConfigAlgorithm constants reflect the NodeBalancer Config Algorithm
|
||||
const (
|
||||
AlgorithmRoundRobin ConfigAlgorithm = "roundrobin"
|
||||
AlgorithmLeastConn ConfigAlgorithm = "leastconn"
|
||||
AlgorithmSource ConfigAlgorithm = "source"
|
||||
)
|
||||
|
||||
// ConfigStickiness constants start with Stickiness and include Linode API NodeBalancer Config Stickiness
|
||||
type ConfigStickiness string
|
||||
|
||||
// ConfigStickiness constants reflect the node stickiness method for a NodeBalancer Config
|
||||
const (
|
||||
StickinessNone ConfigStickiness = "none"
|
||||
StickinessTable ConfigStickiness = "table"
|
||||
StickinessHTTPCookie ConfigStickiness = "http_cookie"
|
||||
)
|
||||
|
||||
// ConfigCheck constants start with Check and include Linode API NodeBalancer Config Check methods
|
||||
type ConfigCheck string
|
||||
|
||||
// ConfigCheck constants reflect the node health status checking method for a NodeBalancer Config
|
||||
const (
|
||||
CheckNone ConfigCheck = "none"
|
||||
CheckConnection ConfigCheck = "connection"
|
||||
CheckHTTP ConfigCheck = "http"
|
||||
CheckHTTPBody ConfigCheck = "http_body"
|
||||
)
|
||||
|
||||
// ConfigProtocol constants start with Protocol and include Linode API Nodebalancer Config protocols
|
||||
type ConfigProtocol string
|
||||
|
||||
// ConfigProtocol constants reflect the protocol used by a NodeBalancer Config
|
||||
const (
|
||||
ProtocolHTTP ConfigProtocol = "http"
|
||||
ProtocolHTTPS ConfigProtocol = "https"
|
||||
ProtocolTCP ConfigProtocol = "tcp"
|
||||
)
|
||||
|
||||
// ConfigCipher constants start with Cipher and include Linode API NodeBalancer Config Cipher values
|
||||
type ConfigCipher string
|
||||
|
||||
// ConfigCipher constants reflect the preferred cipher set for a NodeBalancer Config
|
||||
const (
|
||||
CipherRecommended ConfigCipher = "recommended"
|
||||
CipherLegacy ConfigCipher = "legacy"
|
||||
)
|
||||
|
||||
// NodeBalancerNodeStatus represents the total number of nodes whose status is Up or Down
|
||||
type NodeBalancerNodeStatus struct {
|
||||
Up int `json:"up"`
|
||||
Down int `json:"down"`
|
||||
}
|
||||
|
||||
// NodeBalancerConfigCreateOptions are permitted by CreateNodeBalancerConfig
|
||||
type NodeBalancerConfigCreateOptions struct {
|
||||
Port int `json:"port"`
|
||||
Protocol ConfigProtocol `json:"protocol,omitempty"`
|
||||
Algorithm ConfigAlgorithm `json:"algorithm,omitempty"`
|
||||
Stickiness ConfigStickiness `json:"stickiness,omitempty"`
|
||||
Check ConfigCheck `json:"check,omitempty"`
|
||||
CheckInterval int `json:"check_interval,omitempty"`
|
||||
CheckAttempts int `json:"check_attempts,omitempty"`
|
||||
CheckPath string `json:"check_path,omitempty"`
|
||||
CheckBody string `json:"check_body,omitempty"`
|
||||
CheckPassive *bool `json:"check_passive,omitempty"`
|
||||
CheckTimeout int `json:"check_timeout,omitempty"`
|
||||
CipherSuite ConfigCipher `json:"cipher_suite,omitempty"`
|
||||
SSLCert string `json:"ssl_cert,omitempty"`
|
||||
SSLKey string `json:"ssl_key,omitempty"`
|
||||
Nodes []NodeBalancerNodeCreateOptions `json:"nodes,omitempty"`
|
||||
}
|
||||
|
||||
// NodeBalancerConfigRebuildOptions used by RebuildNodeBalancerConfig
|
||||
type NodeBalancerConfigRebuildOptions struct {
|
||||
Port int `json:"port"`
|
||||
Protocol ConfigProtocol `json:"protocol,omitempty"`
|
||||
Algorithm ConfigAlgorithm `json:"algorithm,omitempty"`
|
||||
Stickiness ConfigStickiness `json:"stickiness,omitempty"`
|
||||
Check ConfigCheck `json:"check,omitempty"`
|
||||
CheckInterval int `json:"check_interval,omitempty"`
|
||||
CheckAttempts int `json:"check_attempts,omitempty"`
|
||||
CheckPath string `json:"check_path,omitempty"`
|
||||
CheckBody string `json:"check_body,omitempty"`
|
||||
CheckPassive *bool `json:"check_passive,omitempty"`
|
||||
CheckTimeout int `json:"check_timeout,omitempty"`
|
||||
CipherSuite ConfigCipher `json:"cipher_suite,omitempty"`
|
||||
SSLCert string `json:"ssl_cert,omitempty"`
|
||||
SSLKey string `json:"ssl_key,omitempty"`
|
||||
Nodes []NodeBalancerNodeCreateOptions `json:"nodes"`
|
||||
}
|
||||
|
||||
// NodeBalancerConfigUpdateOptions are permitted by UpdateNodeBalancerConfig
|
||||
type NodeBalancerConfigUpdateOptions NodeBalancerConfigCreateOptions
|
||||
|
||||
// GetCreateOptions converts a NodeBalancerConfig to NodeBalancerConfigCreateOptions for use in CreateNodeBalancerConfig
|
||||
func (i NodeBalancerConfig) GetCreateOptions() NodeBalancerConfigCreateOptions {
|
||||
return NodeBalancerConfigCreateOptions{
|
||||
Port: i.Port,
|
||||
Protocol: i.Protocol,
|
||||
Algorithm: i.Algorithm,
|
||||
Stickiness: i.Stickiness,
|
||||
Check: i.Check,
|
||||
CheckInterval: i.CheckInterval,
|
||||
CheckAttempts: i.CheckAttempts,
|
||||
CheckTimeout: i.CheckTimeout,
|
||||
CheckPath: i.CheckPath,
|
||||
CheckBody: i.CheckBody,
|
||||
CheckPassive: copyBool(&i.CheckPassive),
|
||||
CipherSuite: i.CipherSuite,
|
||||
SSLCert: i.SSLCert,
|
||||
SSLKey: i.SSLKey,
|
||||
}
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts a NodeBalancerConfig to NodeBalancerConfigUpdateOptions for use in UpdateNodeBalancerConfig
|
||||
func (i NodeBalancerConfig) GetUpdateOptions() NodeBalancerConfigUpdateOptions {
|
||||
return NodeBalancerConfigUpdateOptions{
|
||||
Port: i.Port,
|
||||
Protocol: i.Protocol,
|
||||
Algorithm: i.Algorithm,
|
||||
Stickiness: i.Stickiness,
|
||||
Check: i.Check,
|
||||
CheckInterval: i.CheckInterval,
|
||||
CheckAttempts: i.CheckAttempts,
|
||||
CheckPath: i.CheckPath,
|
||||
CheckBody: i.CheckBody,
|
||||
CheckPassive: copyBool(&i.CheckPassive),
|
||||
CheckTimeout: i.CheckTimeout,
|
||||
CipherSuite: i.CipherSuite,
|
||||
SSLCert: i.SSLCert,
|
||||
SSLKey: i.SSLKey,
|
||||
}
|
||||
}
|
||||
|
||||
// GetRebuildOptions converts a NodeBalancerConfig to NodeBalancerConfigRebuildOptions for use in RebuildNodeBalancerConfig
|
||||
func (i NodeBalancerConfig) GetRebuildOptions() NodeBalancerConfigRebuildOptions {
|
||||
return NodeBalancerConfigRebuildOptions{
|
||||
Port: i.Port,
|
||||
Protocol: i.Protocol,
|
||||
Algorithm: i.Algorithm,
|
||||
Stickiness: i.Stickiness,
|
||||
Check: i.Check,
|
||||
CheckInterval: i.CheckInterval,
|
||||
CheckAttempts: i.CheckAttempts,
|
||||
CheckTimeout: i.CheckTimeout,
|
||||
CheckPath: i.CheckPath,
|
||||
CheckBody: i.CheckBody,
|
||||
CheckPassive: copyBool(&i.CheckPassive),
|
||||
CipherSuite: i.CipherSuite,
|
||||
SSLCert: i.SSLCert,
|
||||
SSLKey: i.SSLKey,
|
||||
Nodes: make([]NodeBalancerNodeCreateOptions, 0),
|
||||
}
|
||||
}
|
||||
|
||||
// NodeBalancerConfigsPagedResponse represents a paginated NodeBalancerConfig API response
|
||||
type NodeBalancerConfigsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []NodeBalancerConfig `json:"data"`
|
||||
}
|
||||
|
||||
// endpointWithID gets the endpoint URL for NodeBalancerConfig
|
||||
func (NodeBalancerConfigsPagedResponse) endpointWithID(c *Client, id int) string {
|
||||
endpoint, err := c.NodeBalancerConfigs.endpointWithID(id)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends NodeBalancerConfigs when processing paginated NodeBalancerConfig responses
|
||||
func (resp *NodeBalancerConfigsPagedResponse) appendData(r *NodeBalancerConfigsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListNodeBalancerConfigs lists NodeBalancerConfigs
|
||||
func (c *Client) ListNodeBalancerConfigs(ctx context.Context, nodebalancerID int, opts *ListOptions) ([]NodeBalancerConfig, error) {
|
||||
response := NodeBalancerConfigsPagedResponse{}
|
||||
err := c.listHelperWithID(ctx, &response, nodebalancerID, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (i *NodeBalancerConfig) fixDates() *NodeBalancerConfig {
|
||||
return i
|
||||
}
|
||||
|
||||
// GetNodeBalancerConfig gets the template with the provided ID
|
||||
func (c *Client) GetNodeBalancerConfig(ctx context.Context, nodebalancerID int, configID int) (*NodeBalancerConfig, error) {
|
||||
e, err := c.NodeBalancerConfigs.endpointWithID(nodebalancerID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, configID)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&NodeBalancerConfig{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*NodeBalancerConfig).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateNodeBalancerConfig creates a NodeBalancerConfig
|
||||
func (c *Client) CreateNodeBalancerConfig(ctx context.Context, nodebalancerID int, nodebalancerConfig NodeBalancerConfigCreateOptions) (*NodeBalancerConfig, error) {
|
||||
var body string
|
||||
e, err := c.NodeBalancerConfigs.endpointWithID(nodebalancerID)
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&NodeBalancerConfig{})
|
||||
|
||||
if bodyData, err := json.Marshal(nodebalancerConfig); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetHeader("Content-Type", "application/json").
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*NodeBalancerConfig).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateNodeBalancerConfig updates the NodeBalancerConfig with the specified id
|
||||
func (c *Client) UpdateNodeBalancerConfig(ctx context.Context, nodebalancerID int, configID int, updateOpts NodeBalancerConfigUpdateOptions) (*NodeBalancerConfig, error) {
|
||||
var body string
|
||||
e, err := c.NodeBalancerConfigs.endpointWithID(nodebalancerID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, configID)
|
||||
|
||||
req := c.R(ctx).SetResult(&NodeBalancerConfig{})
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*NodeBalancerConfig).fixDates(), nil
|
||||
}
|
||||
|
||||
// DeleteNodeBalancerConfig deletes the NodeBalancerConfig with the specified id
|
||||
func (c *Client) DeleteNodeBalancerConfig(ctx context.Context, nodebalancerID int, configID int) error {
|
||||
e, err := c.NodeBalancerConfigs.endpointWithID(nodebalancerID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, configID)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
||||
// RebuildNodeBalancerConfig updates the NodeBalancer with the specified id
|
||||
func (c *Client) RebuildNodeBalancerConfig(ctx context.Context, nodeBalancerID int, configID int, rebuildOpts NodeBalancerConfigRebuildOptions) (*NodeBalancerConfig, error) {
|
||||
var body string
|
||||
e, err := c.NodeBalancerConfigs.endpointWithID(nodeBalancerID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d/rebuild", e, configID)
|
||||
|
||||
req := c.R(ctx).SetResult(&NodeBalancerConfig{})
|
||||
|
||||
if bodyData, err := json.Marshal(rebuildOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*NodeBalancerConfig).fixDates(), nil
|
||||
}
|
||||
|
|
@ -0,0 +1,430 @@
|
|||
package linodego
|
||||
|
||||
/**
|
||||
* Pagination and Filtering types and helpers
|
||||
*/
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log"
|
||||
"strconv"
|
||||
|
||||
"gopkg.in/resty.v1"
|
||||
)
|
||||
|
||||
// PageOptions are the pagination parameters for List endpoints
|
||||
type PageOptions struct {
|
||||
Page int `url:"page,omitempty" json:"page"`
|
||||
Pages int `url:"pages,omitempty" json:"pages"`
|
||||
Results int `url:"results,omitempty" json:"results"`
|
||||
}
|
||||
|
||||
// ListOptions are the pagination and filtering (TODO) parameters for endpoints
|
||||
type ListOptions struct {
|
||||
*PageOptions
|
||||
Filter string
|
||||
}
|
||||
|
||||
// NewListOptions simplified construction of ListOptions using only
|
||||
// the two writable properties, Page and Filter
|
||||
func NewListOptions(Page int, Filter string) *ListOptions {
|
||||
return &ListOptions{PageOptions: &PageOptions{Page: Page}, Filter: Filter}
|
||||
|
||||
}
|
||||
|
||||
// listHelper abstracts fetching and pagination for GET endpoints that
|
||||
// do not require any Ids (top level endpoints).
|
||||
// When opts (or opts.Page) is nil, all pages will be fetched and
|
||||
// returned in a single (endpoint-specific)PagedResponse
|
||||
// opts.results and opts.pages will be updated from the API response
|
||||
func (c *Client) listHelper(ctx context.Context, i interface{}, opts *ListOptions) error {
|
||||
req := c.R(ctx)
|
||||
if opts != nil && opts.PageOptions != nil && opts.Page > 0 {
|
||||
req.SetQueryParam("page", strconv.Itoa(opts.Page))
|
||||
}
|
||||
|
||||
var (
|
||||
err error
|
||||
pages int
|
||||
results int
|
||||
r *resty.Response
|
||||
)
|
||||
|
||||
if opts != nil && len(opts.Filter) > 0 {
|
||||
req.SetHeader("X-Filter", opts.Filter)
|
||||
}
|
||||
|
||||
switch v := i.(type) {
|
||||
case *LinodeKernelsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(LinodeKernelsPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*LinodeKernelsPagedResponse).Pages
|
||||
results = r.Result().(*LinodeKernelsPagedResponse).Results
|
||||
v.appendData(r.Result().(*LinodeKernelsPagedResponse))
|
||||
}
|
||||
case *LinodeTypesPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(LinodeTypesPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*LinodeTypesPagedResponse).Pages
|
||||
results = r.Result().(*LinodeTypesPagedResponse).Results
|
||||
v.appendData(r.Result().(*LinodeTypesPagedResponse))
|
||||
}
|
||||
case *ImagesPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(ImagesPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*ImagesPagedResponse).Pages
|
||||
results = r.Result().(*ImagesPagedResponse).Results
|
||||
v.appendData(r.Result().(*ImagesPagedResponse))
|
||||
}
|
||||
case *StackscriptsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(StackscriptsPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*StackscriptsPagedResponse).Pages
|
||||
results = r.Result().(*StackscriptsPagedResponse).Results
|
||||
v.appendData(r.Result().(*StackscriptsPagedResponse))
|
||||
}
|
||||
case *InstancesPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(InstancesPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*InstancesPagedResponse).Pages
|
||||
results = r.Result().(*InstancesPagedResponse).Results
|
||||
v.appendData(r.Result().(*InstancesPagedResponse))
|
||||
}
|
||||
case *RegionsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(RegionsPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*RegionsPagedResponse).Pages
|
||||
results = r.Result().(*RegionsPagedResponse).Results
|
||||
v.appendData(r.Result().(*RegionsPagedResponse))
|
||||
}
|
||||
case *VolumesPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(VolumesPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*VolumesPagedResponse).Pages
|
||||
results = r.Result().(*VolumesPagedResponse).Results
|
||||
v.appendData(r.Result().(*VolumesPagedResponse))
|
||||
}
|
||||
case *DomainsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(DomainsPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
response, ok := r.Result().(*DomainsPagedResponse)
|
||||
if !ok {
|
||||
return fmt.Errorf("Response is not a *DomainsPagedResponse")
|
||||
}
|
||||
pages = response.Pages
|
||||
results = response.Results
|
||||
v.appendData(response)
|
||||
}
|
||||
case *EventsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(EventsPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*EventsPagedResponse).Pages
|
||||
results = r.Result().(*EventsPagedResponse).Results
|
||||
v.appendData(r.Result().(*EventsPagedResponse))
|
||||
}
|
||||
case *LongviewSubscriptionsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(LongviewSubscriptionsPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*LongviewSubscriptionsPagedResponse).Pages
|
||||
results = r.Result().(*LongviewSubscriptionsPagedResponse).Results
|
||||
v.appendData(r.Result().(*LongviewSubscriptionsPagedResponse))
|
||||
}
|
||||
case *LongviewClientsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(LongviewClientsPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*LongviewClientsPagedResponse).Pages
|
||||
results = r.Result().(*LongviewClientsPagedResponse).Results
|
||||
v.appendData(r.Result().(*LongviewClientsPagedResponse))
|
||||
}
|
||||
case *IPAddressesPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(IPAddressesPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*IPAddressesPagedResponse).Pages
|
||||
results = r.Result().(*IPAddressesPagedResponse).Results
|
||||
v.appendData(r.Result().(*IPAddressesPagedResponse))
|
||||
}
|
||||
case *IPv6PoolsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(IPv6PoolsPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*IPv6PoolsPagedResponse).Pages
|
||||
results = r.Result().(*IPv6PoolsPagedResponse).Results
|
||||
v.appendData(r.Result().(*IPv6PoolsPagedResponse))
|
||||
}
|
||||
case *IPv6RangesPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(IPv6RangesPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*IPv6RangesPagedResponse).Pages
|
||||
results = r.Result().(*IPv6RangesPagedResponse).Results
|
||||
v.appendData(r.Result().(*IPv6RangesPagedResponse))
|
||||
// @TODO consolidate this type with IPv6PoolsPagedResponse?
|
||||
}
|
||||
case *SSHKeysPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(SSHKeysPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
response, ok := r.Result().(*SSHKeysPagedResponse)
|
||||
if !ok {
|
||||
return fmt.Errorf("Response is not a *SSHKeysPagedResponse")
|
||||
}
|
||||
pages = response.Pages
|
||||
results = response.Results
|
||||
v.appendData(response)
|
||||
}
|
||||
case *TicketsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(TicketsPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*TicketsPagedResponse).Pages
|
||||
results = r.Result().(*TicketsPagedResponse).Results
|
||||
v.appendData(r.Result().(*TicketsPagedResponse))
|
||||
}
|
||||
case *InvoicesPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(InvoicesPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*InvoicesPagedResponse).Pages
|
||||
results = r.Result().(*InvoicesPagedResponse).Results
|
||||
v.appendData(r.Result().(*InvoicesPagedResponse))
|
||||
}
|
||||
case *NotificationsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(NotificationsPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*NotificationsPagedResponse).Pages
|
||||
results = r.Result().(*NotificationsPagedResponse).Results
|
||||
v.appendData(r.Result().(*NotificationsPagedResponse))
|
||||
}
|
||||
case *NodeBalancersPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(NodeBalancersPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*NodeBalancersPagedResponse).Pages
|
||||
results = r.Result().(*NodeBalancersPagedResponse).Results
|
||||
v.appendData(r.Result().(*NodeBalancersPagedResponse))
|
||||
}
|
||||
case *TagsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(TagsPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*TagsPagedResponse).Pages
|
||||
results = r.Result().(*TagsPagedResponse).Results
|
||||
v.appendData(r.Result().(*TagsPagedResponse))
|
||||
}
|
||||
case *TokensPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(TokensPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*TokensPagedResponse).Pages
|
||||
results = r.Result().(*TokensPagedResponse).Results
|
||||
v.appendData(r.Result().(*TokensPagedResponse))
|
||||
}
|
||||
case *UsersPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(UsersPagedResponse{}).Get(v.endpoint(c))); err == nil {
|
||||
pages = r.Result().(*UsersPagedResponse).Pages
|
||||
results = r.Result().(*UsersPagedResponse).Results
|
||||
v.appendData(r.Result().(*UsersPagedResponse))
|
||||
}
|
||||
/**
|
||||
case AccountOauthClientsPagedResponse:
|
||||
case AccountPaymentsPagedResponse:
|
||||
case ProfileAppsPagedResponse:
|
||||
case ProfileWhitelistPagedResponse:
|
||||
case ManagedContactsPagedResponse:
|
||||
case ManagedCredentialsPagedResponse:
|
||||
case ManagedIssuesPagedResponse:
|
||||
case ManagedLinodeSettingsPagedResponse:
|
||||
case ManagedServicesPagedResponse:
|
||||
**/
|
||||
default:
|
||||
log.Fatalf("listHelper interface{} %+v used", i)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if opts == nil {
|
||||
for page := 2; page <= pages; page = page + 1 {
|
||||
if err := c.listHelper(ctx, i, &ListOptions{PageOptions: &PageOptions{Page: page}}); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if opts.PageOptions == nil {
|
||||
opts.PageOptions = &PageOptions{}
|
||||
}
|
||||
|
||||
if opts.Page == 0 {
|
||||
for page := 2; page <= pages; page = page + 1 {
|
||||
opts.Page = page
|
||||
if err := c.listHelper(ctx, i, opts); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
opts.Results = results
|
||||
opts.Pages = pages
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// listHelperWithID abstracts fetching and pagination for GET endpoints that
|
||||
// require an Id (second level endpoints).
|
||||
// When opts (or opts.Page) is nil, all pages will be fetched and
|
||||
// returned in a single (endpoint-specific)PagedResponse
|
||||
// opts.results and opts.pages will be updated from the API response
|
||||
func (c *Client) listHelperWithID(ctx context.Context, i interface{}, idRaw interface{}, opts *ListOptions) error {
|
||||
req := c.R(ctx)
|
||||
if opts != nil && opts.Page > 0 {
|
||||
req.SetQueryParam("page", strconv.Itoa(opts.Page))
|
||||
}
|
||||
|
||||
var (
|
||||
err error
|
||||
pages int
|
||||
results int
|
||||
r *resty.Response
|
||||
)
|
||||
|
||||
id, _ := idRaw.(int)
|
||||
|
||||
if opts != nil && len(opts.Filter) > 0 {
|
||||
req.SetHeader("X-Filter", opts.Filter)
|
||||
}
|
||||
|
||||
switch v := i.(type) {
|
||||
case *InvoiceItemsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(InvoiceItemsPagedResponse{}).Get(v.endpointWithID(c, id))); err == nil {
|
||||
pages = r.Result().(*InvoiceItemsPagedResponse).Pages
|
||||
results = r.Result().(*InvoiceItemsPagedResponse).Results
|
||||
v.appendData(r.Result().(*InvoiceItemsPagedResponse))
|
||||
}
|
||||
case *DomainRecordsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(DomainRecordsPagedResponse{}).Get(v.endpointWithID(c, id))); err == nil {
|
||||
response, ok := r.Result().(*DomainRecordsPagedResponse)
|
||||
if !ok {
|
||||
return fmt.Errorf("Response is not a *DomainRecordsPagedResponse")
|
||||
}
|
||||
pages = response.Pages
|
||||
results = response.Results
|
||||
v.appendData(response)
|
||||
}
|
||||
case *InstanceConfigsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(InstanceConfigsPagedResponse{}).Get(v.endpointWithID(c, id))); err == nil {
|
||||
pages = r.Result().(*InstanceConfigsPagedResponse).Pages
|
||||
results = r.Result().(*InstanceConfigsPagedResponse).Results
|
||||
v.appendData(r.Result().(*InstanceConfigsPagedResponse))
|
||||
}
|
||||
case *InstanceDisksPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(InstanceDisksPagedResponse{}).Get(v.endpointWithID(c, id))); err == nil {
|
||||
pages = r.Result().(*InstanceDisksPagedResponse).Pages
|
||||
results = r.Result().(*InstanceDisksPagedResponse).Results
|
||||
v.appendData(r.Result().(*InstanceDisksPagedResponse))
|
||||
}
|
||||
case *NodeBalancerConfigsPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(NodeBalancerConfigsPagedResponse{}).Get(v.endpointWithID(c, id))); err == nil {
|
||||
pages = r.Result().(*NodeBalancerConfigsPagedResponse).Pages
|
||||
results = r.Result().(*NodeBalancerConfigsPagedResponse).Results
|
||||
v.appendData(r.Result().(*NodeBalancerConfigsPagedResponse))
|
||||
}
|
||||
case *InstanceVolumesPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(InstanceVolumesPagedResponse{}).Get(v.endpointWithID(c, id))); err == nil {
|
||||
pages = r.Result().(*InstanceVolumesPagedResponse).Pages
|
||||
results = r.Result().(*InstanceVolumesPagedResponse).Results
|
||||
v.appendData(r.Result().(*InstanceVolumesPagedResponse))
|
||||
}
|
||||
case *TaggedObjectsPagedResponse:
|
||||
idStr := idRaw.(string)
|
||||
|
||||
if r, err = coupleAPIErrors(req.SetResult(TaggedObjectsPagedResponse{}).Get(v.endpointWithID(c, idStr))); err == nil {
|
||||
pages = r.Result().(*TaggedObjectsPagedResponse).Pages
|
||||
results = r.Result().(*TaggedObjectsPagedResponse).Results
|
||||
v.appendData(r.Result().(*TaggedObjectsPagedResponse))
|
||||
}
|
||||
/**
|
||||
case TicketAttachmentsPagedResponse:
|
||||
if r, err = req.SetResult(v).Get(v.endpoint(c)); r.Error() != nil {
|
||||
return NewError(r)
|
||||
} else if err == nil {
|
||||
pages = r.Result().(*TicketAttachmentsPagedResponse).Pages
|
||||
results = r.Result().(*TicketAttachmentsPagedResponse).Results
|
||||
v.appendData(r.Result().(*TicketAttachmentsPagedResponse))
|
||||
}
|
||||
case TicketRepliesPagedResponse:
|
||||
if r, err = req.SetResult(v).Get(v.endpoint(c)); r.Error() != nil {
|
||||
return NewError(r)
|
||||
} else if err == nil {
|
||||
pages = r.Result().(*TicketRepliesPagedResponse).Pages
|
||||
results = r.Result().(*TicketRepliesPagedResponse).Results
|
||||
v.appendData(r.Result().(*TicketRepliesPagedResponse))
|
||||
}
|
||||
**/
|
||||
default:
|
||||
log.Fatalf("Unknown listHelperWithID interface{} %T used", i)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if opts == nil {
|
||||
for page := 2; page <= pages; page = page + 1 {
|
||||
if err := c.listHelperWithID(ctx, i, id, &ListOptions{PageOptions: &PageOptions{Page: page}}); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if opts.PageOptions == nil {
|
||||
opts.PageOptions = &PageOptions{}
|
||||
}
|
||||
if opts.Page == 0 {
|
||||
for page := 2; page <= pages; page = page + 1 {
|
||||
opts.Page = page
|
||||
if err := c.listHelperWithID(ctx, i, id, opts); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
opts.Results = results
|
||||
opts.Pages = pages
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// listHelperWithTwoIDs abstracts fetching and pagination for GET endpoints that
|
||||
// require twos IDs (third level endpoints).
|
||||
// When opts (or opts.Page) is nil, all pages will be fetched and
|
||||
// returned in a single (endpoint-specific)PagedResponse
|
||||
// opts.results and opts.pages will be updated from the API response
|
||||
func (c *Client) listHelperWithTwoIDs(ctx context.Context, i interface{}, firstID, secondID int, opts *ListOptions) error {
|
||||
req := c.R(ctx)
|
||||
if opts != nil && opts.Page > 0 {
|
||||
req.SetQueryParam("page", strconv.Itoa(opts.Page))
|
||||
}
|
||||
|
||||
var (
|
||||
err error
|
||||
pages int
|
||||
results int
|
||||
r *resty.Response
|
||||
)
|
||||
|
||||
if opts != nil && len(opts.Filter) > 0 {
|
||||
req.SetHeader("X-Filter", opts.Filter)
|
||||
}
|
||||
|
||||
switch v := i.(type) {
|
||||
case *NodeBalancerNodesPagedResponse:
|
||||
if r, err = coupleAPIErrors(req.SetResult(NodeBalancerNodesPagedResponse{}).Get(v.endpointWithTwoIDs(c, firstID, secondID))); err == nil {
|
||||
pages = r.Result().(*NodeBalancerNodesPagedResponse).Pages
|
||||
results = r.Result().(*NodeBalancerNodesPagedResponse).Results
|
||||
v.appendData(r.Result().(*NodeBalancerNodesPagedResponse))
|
||||
}
|
||||
|
||||
default:
|
||||
log.Fatalf("Unknown listHelperWithTwoIDs interface{} %T used", i)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if opts == nil {
|
||||
for page := 2; page <= pages; page = page + 1 {
|
||||
if err := c.listHelper(ctx, i, &ListOptions{PageOptions: &PageOptions{Page: page}}); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if opts.PageOptions == nil {
|
||||
opts.PageOptions = &PageOptions{}
|
||||
}
|
||||
if opts.Page == 0 {
|
||||
for page := 2; page <= pages; page = page + 1 {
|
||||
opts.Page = page
|
||||
if err := c.listHelperWithTwoIDs(ctx, i, firstID, secondID, opts); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
opts.Results = results
|
||||
opts.Pages = pages
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
|
@ -0,0 +1,117 @@
|
|||
package linodego
|
||||
|
||||
/*
|
||||
- copy profile_test.go and do the same
|
||||
- When updating Profile structs,
|
||||
- use pointers where ever null'able would have a different meaning if the wrapper
|
||||
supplied "" or 0 instead
|
||||
- Add "NameOfResource" to client.go, resources.go, pagination.go
|
||||
*/
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
)
|
||||
|
||||
// LishAuthMethod constants start with AuthMethod and include Linode API Lish Authentication Methods
|
||||
type LishAuthMethod string
|
||||
|
||||
// LishAuthMethod constants are the methods of authentication allowed when connecting via Lish
|
||||
const (
|
||||
AuthMethodPasswordKeys LishAuthMethod = "password_keys"
|
||||
AuthMethodKeysOnly LishAuthMethod = "keys_only"
|
||||
AuthMethodDisabled LishAuthMethod = "disabled"
|
||||
)
|
||||
|
||||
// ProfileReferrals represent a User's status in the Referral Program
|
||||
type ProfileReferrals struct {
|
||||
Total int `json:"total"`
|
||||
Completed int `json:"completed"`
|
||||
Pending int `json:"pending"`
|
||||
Credit float64 `json:"credit"`
|
||||
Code string `json:"code"`
|
||||
URL string `json:"url"`
|
||||
}
|
||||
|
||||
// Profile represents a Profile object
|
||||
type Profile struct {
|
||||
UID int `json:"uid"`
|
||||
Username string `json:"username"`
|
||||
Email string `json:"email"`
|
||||
Timezone string `json:"timezone"`
|
||||
EmailNotifications bool `json:"email_notifications"`
|
||||
IPWhitelistEnabled bool `json:"ip_whitelist_enabled"`
|
||||
TwoFactorAuth bool `json:"two_factor_auth"`
|
||||
Restricted bool `json:"restricted"`
|
||||
LishAuthMethod LishAuthMethod `json:"lish_auth_method"`
|
||||
Referrals ProfileReferrals `json:"referrals"`
|
||||
AuthorizedKeys []string `json:"authorized_keys"`
|
||||
}
|
||||
|
||||
// ProfileUpdateOptions fields are those accepted by UpdateProfile
|
||||
type ProfileUpdateOptions struct {
|
||||
Email string `json:"email,omitempty"`
|
||||
Timezone string `json:"timezone,omitempty"`
|
||||
EmailNotifications *bool `json:"email_notifications,omitempty"`
|
||||
IPWhitelistEnabled *bool `json:"ip_whitelist_enabled,omitempty"`
|
||||
LishAuthMethod LishAuthMethod `json:"lish_auth_method,omitempty"`
|
||||
AuthorizedKeys *[]string `json:"authorized_keys,omitempty"`
|
||||
TwoFactorAuth *bool `json:"two_factor_auth,omitempty"`
|
||||
Restricted *bool `json:"restricted,omitempty"`
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts a Profile to ProfileUpdateOptions for use in UpdateProfile
|
||||
func (i Profile) GetUpdateOptions() (o ProfileUpdateOptions) {
|
||||
o.Email = i.Email
|
||||
o.Timezone = i.Timezone
|
||||
o.EmailNotifications = copyBool(&i.EmailNotifications)
|
||||
o.IPWhitelistEnabled = copyBool(&i.IPWhitelistEnabled)
|
||||
o.LishAuthMethod = i.LishAuthMethod
|
||||
authorizedKeys := make([]string, len(i.AuthorizedKeys))
|
||||
copy(authorizedKeys, i.AuthorizedKeys)
|
||||
o.AuthorizedKeys = &authorizedKeys
|
||||
o.TwoFactorAuth = copyBool(&i.TwoFactorAuth)
|
||||
o.Restricted = copyBool(&i.Restricted)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// GetProfile gets the profile with the provided ID
|
||||
func (c *Client) GetProfile(ctx context.Context) (*Profile, error) {
|
||||
e, err := c.Profile.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&Profile{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Profile), nil
|
||||
}
|
||||
|
||||
// UpdateProfile updates the Profile with the specified id
|
||||
func (c *Client) UpdateProfile(ctx context.Context, updateOpts ProfileUpdateOptions) (*Profile, error) {
|
||||
var body string
|
||||
e, err := c.Profile.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&Profile{})
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Profile), nil
|
||||
}
|
||||
|
|
@ -0,0 +1,160 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// SSHKey represents a SSHKey object
|
||||
type SSHKey struct {
|
||||
ID int `json:"id"`
|
||||
Label string `json:"label"`
|
||||
SSHKey string `json:"ssh_key"`
|
||||
CreatedStr string `json:"created"`
|
||||
Created *time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// SSHKeyCreateOptions fields are those accepted by CreateSSHKey
|
||||
type SSHKeyCreateOptions struct {
|
||||
Label string `json:"label"`
|
||||
SSHKey string `json:"ssh_key"`
|
||||
}
|
||||
|
||||
// SSHKeyUpdateOptions fields are those accepted by UpdateSSHKey
|
||||
type SSHKeyUpdateOptions struct {
|
||||
Label string `json:"label"`
|
||||
}
|
||||
|
||||
// GetCreateOptions converts a SSHKey to SSHKeyCreateOptions for use in CreateSSHKey
|
||||
func (i SSHKey) GetCreateOptions() (o SSHKeyCreateOptions) {
|
||||
o.Label = i.Label
|
||||
o.SSHKey = i.SSHKey
|
||||
return
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts a SSHKey to SSHKeyCreateOptions for use in UpdateSSHKey
|
||||
func (i SSHKey) GetUpdateOptions() (o SSHKeyUpdateOptions) {
|
||||
o.Label = i.Label
|
||||
return
|
||||
}
|
||||
|
||||
// SSHKeysPagedResponse represents a paginated SSHKey API response
|
||||
type SSHKeysPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []SSHKey `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for SSHKey
|
||||
func (SSHKeysPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.SSHKeys.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends SSHKeys when processing paginated SSHKey responses
|
||||
func (resp *SSHKeysPagedResponse) appendData(r *SSHKeysPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListSSHKeys lists SSHKeys
|
||||
func (c *Client) ListSSHKeys(ctx context.Context, opts *ListOptions) ([]SSHKey, error) {
|
||||
response := SSHKeysPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (i *SSHKey) fixDates() *SSHKey {
|
||||
i.Created, _ = parseDates(i.CreatedStr)
|
||||
return i
|
||||
}
|
||||
|
||||
// GetSSHKey gets the sshkey with the provided ID
|
||||
func (c *Client) GetSSHKey(ctx context.Context, id int) (*SSHKey, error) {
|
||||
e, err := c.SSHKeys.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&SSHKey{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*SSHKey).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateSSHKey creates a SSHKey
|
||||
func (c *Client) CreateSSHKey(ctx context.Context, createOpts SSHKeyCreateOptions) (*SSHKey, error) {
|
||||
var body string
|
||||
e, err := c.SSHKeys.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&SSHKey{})
|
||||
|
||||
if bodyData, err := json.Marshal(createOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*SSHKey).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateSSHKey updates the SSHKey with the specified id
|
||||
func (c *Client) UpdateSSHKey(ctx context.Context, id int, updateOpts SSHKeyUpdateOptions) (*SSHKey, error) {
|
||||
var body string
|
||||
e, err := c.SSHKeys.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
req := c.R(ctx).SetResult(&SSHKey{})
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*SSHKey).fixDates(), nil
|
||||
}
|
||||
|
||||
// DeleteSSHKey deletes the SSHKey with the specified id
|
||||
func (c *Client) DeleteSSHKey(ctx context.Context, id int) error {
|
||||
e, err := c.SSHKeys.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,195 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Token represents a Token object
|
||||
type Token struct {
|
||||
// This token's unique ID, which can be used to revoke it.
|
||||
ID int `json:"id"`
|
||||
|
||||
// The scopes this token was created with. These define what parts of the Account the token can be used to access. Many command-line tools, such as the Linode CLI, require tokens with access to *. Tokens with more restrictive scopes are generally more secure.
|
||||
Scopes string `json:"scopes"`
|
||||
|
||||
// This token's label. This is for display purposes only, but can be used to more easily track what you're using each token for. (1-100 Characters)
|
||||
Label string `json:"label"`
|
||||
|
||||
// The token used to access the API. When the token is created, the full token is returned here. Otherwise, only the first 16 characters are returned.
|
||||
Token string `json:"token"`
|
||||
|
||||
// The date and time this token was created.
|
||||
Created *time.Time `json:"-"`
|
||||
CreatedStr string `json:"created"`
|
||||
|
||||
// When this token will expire. Personal Access Tokens cannot be renewed, so after this time the token will be completely unusable and a new token will need to be generated. Tokens may be created with "null" as their expiry and will never expire unless revoked.
|
||||
Expiry *time.Time `json:"-"`
|
||||
ExpiryStr string `json:"expiry"`
|
||||
}
|
||||
|
||||
// TokenCreateOptions fields are those accepted by CreateToken
|
||||
type TokenCreateOptions struct {
|
||||
// The scopes this token was created with. These define what parts of the Account the token can be used to access. Many command-line tools, such as the Linode CLI, require tokens with access to *. Tokens with more restrictive scopes are generally more secure.
|
||||
Scopes string `json:"scopes"`
|
||||
|
||||
// This token's label. This is for display purposes only, but can be used to more easily track what you're using each token for. (1-100 Characters)
|
||||
Label string `json:"label"`
|
||||
|
||||
// When this token will expire. Personal Access Tokens cannot be renewed, so after this time the token will be completely unusable and a new token will need to be generated. Tokens may be created with "null" as their expiry and will never expire unless revoked.
|
||||
Expiry *time.Time `json:"expiry"`
|
||||
}
|
||||
|
||||
// TokenUpdateOptions fields are those accepted by UpdateToken
|
||||
type TokenUpdateOptions struct {
|
||||
// This token's label. This is for display purposes only, but can be used to more easily track what you're using each token for. (1-100 Characters)
|
||||
Label string `json:"label"`
|
||||
}
|
||||
|
||||
// GetCreateOptions converts a Token to TokenCreateOptions for use in CreateToken
|
||||
func (i Token) GetCreateOptions() (o TokenCreateOptions) {
|
||||
o.Label = i.Label
|
||||
o.Expiry = copyTime(i.Expiry)
|
||||
o.Scopes = i.Scopes
|
||||
return
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts a Token to TokenUpdateOptions for use in UpdateToken
|
||||
func (i Token) GetUpdateOptions() (o TokenUpdateOptions) {
|
||||
o.Label = i.Label
|
||||
return
|
||||
}
|
||||
|
||||
// TokensPagedResponse represents a paginated Token API response
|
||||
type TokensPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Token `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for Token
|
||||
func (TokensPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Tokens.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends Tokens when processing paginated Token responses
|
||||
func (resp *TokensPagedResponse) appendData(r *TokensPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListTokens lists Tokens
|
||||
func (c *Client) ListTokens(ctx context.Context, opts *ListOptions) ([]Token, error) {
|
||||
response := TokensPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (i *Token) fixDates() *Token {
|
||||
i.Created, _ = parseDates(i.CreatedStr)
|
||||
i.Expiry, _ = parseDates(i.ExpiryStr)
|
||||
return i
|
||||
}
|
||||
|
||||
// GetToken gets the token with the provided ID
|
||||
func (c *Client) GetToken(ctx context.Context, id int) (*Token, error) {
|
||||
e, err := c.Tokens.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&Token{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Token).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateToken creates a Token
|
||||
func (c *Client) CreateToken(ctx context.Context, createOpts TokenCreateOptions) (*Token, error) {
|
||||
var body string
|
||||
e, err := c.Tokens.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&Token{})
|
||||
|
||||
// Format the Time as a string to meet the ISO8601 requirement
|
||||
createOptsFixed := struct {
|
||||
Label string `json:"label"`
|
||||
Scopes string `json:"scopes"`
|
||||
Expiry *string `json:"expiry"`
|
||||
}{}
|
||||
createOptsFixed.Label = createOpts.Label
|
||||
createOptsFixed.Scopes = createOpts.Scopes
|
||||
if createOpts.Expiry != nil {
|
||||
iso8601Expiry := createOpts.Expiry.UTC().Format("2006-01-02T15:04:05")
|
||||
createOptsFixed.Expiry = &iso8601Expiry
|
||||
}
|
||||
|
||||
if bodyData, err := json.Marshal(createOptsFixed); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Token).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateToken updates the Token with the specified id
|
||||
func (c *Client) UpdateToken(ctx context.Context, id int, updateOpts TokenUpdateOptions) (*Token, error) {
|
||||
var body string
|
||||
e, err := c.Tokens.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
req := c.R(ctx).SetResult(&Token{})
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Token).fixDates(), nil
|
||||
}
|
||||
|
||||
// DeleteToken deletes the Token with the specified id
|
||||
func (c *Client) DeleteToken(ctx context.Context, id int) error {
|
||||
e, err := c.Tokens.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// Region represents a linode region object
|
||||
type Region struct {
|
||||
ID string `json:"id"`
|
||||
Country string `json:"country"`
|
||||
}
|
||||
|
||||
// RegionsPagedResponse represents a linode API response for listing
|
||||
type RegionsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Region `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for Region
|
||||
func (RegionsPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Regions.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends Regions when processing paginated Region responses
|
||||
func (resp *RegionsPagedResponse) appendData(r *RegionsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListRegions lists Regions
|
||||
func (c *Client) ListRegions(ctx context.Context, opts *ListOptions) ([]Region, error) {
|
||||
response := RegionsPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (v *Region) fixDates() *Region {
|
||||
return v
|
||||
}
|
||||
|
||||
// GetRegion gets the template with the provided ID
|
||||
func (c *Client) GetRegion(ctx context.Context, id string) (*Region, error) {
|
||||
e, err := c.Regions.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&Region{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Region).fixDates(), nil
|
||||
}
|
||||
|
|
@ -0,0 +1,162 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"fmt"
|
||||
"text/template"
|
||||
|
||||
"gopkg.in/resty.v1"
|
||||
)
|
||||
|
||||
const (
|
||||
stackscriptsName = "stackscripts"
|
||||
imagesName = "images"
|
||||
instancesName = "instances"
|
||||
instanceDisksName = "disks"
|
||||
instanceConfigsName = "configs"
|
||||
instanceIPsName = "ips"
|
||||
instanceSnapshotsName = "snapshots"
|
||||
instanceVolumesName = "instancevolumes"
|
||||
ipaddressesName = "ipaddresses"
|
||||
ipv6poolsName = "ipv6pools"
|
||||
ipv6rangesName = "ipv6ranges"
|
||||
regionsName = "regions"
|
||||
volumesName = "volumes"
|
||||
kernelsName = "kernels"
|
||||
typesName = "types"
|
||||
domainsName = "domains"
|
||||
domainRecordsName = "records"
|
||||
longviewName = "longview"
|
||||
longviewclientsName = "longviewclients"
|
||||
longviewsubscriptionsName = "longviewsubscriptions"
|
||||
nodebalancersName = "nodebalancers"
|
||||
nodebalancerconfigsName = "nodebalancerconfigs"
|
||||
nodebalancernodesName = "nodebalancernodes"
|
||||
notificationsName = "notifications"
|
||||
sshkeysName = "sshkeys"
|
||||
ticketsName = "tickets"
|
||||
tokensName = "tokens"
|
||||
accountName = "account"
|
||||
eventsName = "events"
|
||||
invoicesName = "invoices"
|
||||
invoiceItemsName = "invoiceitems"
|
||||
profileName = "profile"
|
||||
managedName = "managed"
|
||||
tagsName = "tags"
|
||||
usersName = "users"
|
||||
// notificationsName = "notifications"
|
||||
|
||||
stackscriptsEndpoint = "linode/stackscripts"
|
||||
imagesEndpoint = "images"
|
||||
instancesEndpoint = "linode/instances"
|
||||
instanceConfigsEndpoint = "linode/instances/{{ .ID }}/configs"
|
||||
instanceDisksEndpoint = "linode/instances/{{ .ID }}/disks"
|
||||
instanceSnapshotsEndpoint = "linode/instances/{{ .ID }}/backups"
|
||||
instanceIPsEndpoint = "linode/instances/{{ .ID }}/ips"
|
||||
instanceVolumesEndpoint = "linode/instances/{{ .ID }}/volumes"
|
||||
ipaddressesEndpoint = "networking/ips"
|
||||
ipv6poolsEndpoint = "networking/ipv6/pools"
|
||||
ipv6rangesEndpoint = "networking/ipv6/ranges"
|
||||
regionsEndpoint = "regions"
|
||||
volumesEndpoint = "volumes"
|
||||
kernelsEndpoint = "linode/kernels"
|
||||
typesEndpoint = "linode/types"
|
||||
domainsEndpoint = "domains"
|
||||
domainRecordsEndpoint = "domains/{{ .ID }}/records"
|
||||
longviewEndpoint = "longview"
|
||||
longviewclientsEndpoint = "longview/clients"
|
||||
longviewsubscriptionsEndpoint = "longview/subscriptions"
|
||||
nodebalancersEndpoint = "nodebalancers"
|
||||
// @TODO we can't use these nodebalancer endpoints unless we include these templated fields
|
||||
// The API seems inconsistent about including parent IDs in objects, (compare instance configs to nb configs)
|
||||
// Parent IDs would be immutable for updates and are ignored in create requests ..
|
||||
// Should we include these fields in CreateOpts and UpdateOpts?
|
||||
nodebalancerconfigsEndpoint = "nodebalancers/{{ .ID }}/configs"
|
||||
nodebalancernodesEndpoint = "nodebalancers/{{ .ID }}/configs/{{ .SecondID }}/nodes"
|
||||
sshkeysEndpoint = "profile/sshkeys"
|
||||
ticketsEndpoint = "support/tickets"
|
||||
tokensEndpoint = "profile/tokens"
|
||||
accountEndpoint = "account"
|
||||
eventsEndpoint = "account/events"
|
||||
invoicesEndpoint = "account/invoices"
|
||||
invoiceItemsEndpoint = "account/invoices/{{ .ID }}/items"
|
||||
profileEndpoint = "profile"
|
||||
managedEndpoint = "managed"
|
||||
tagsEndpoint = "tags"
|
||||
usersEndpoint = "account/users"
|
||||
notificationsEndpoint = "account/notifications"
|
||||
)
|
||||
|
||||
// Resource represents a linode API resource
|
||||
type Resource struct {
|
||||
name string
|
||||
endpoint string
|
||||
isTemplate bool
|
||||
endpointTemplate *template.Template
|
||||
R func(ctx context.Context) *resty.Request
|
||||
PR func(ctx context.Context) *resty.Request
|
||||
}
|
||||
|
||||
// NewResource is the factory to create a new Resource struct. If it has a template string the useTemplate bool must be set.
|
||||
func NewResource(client *Client, name string, endpoint string, useTemplate bool, singleType interface{}, pagedType interface{}) *Resource {
|
||||
var tmpl *template.Template
|
||||
|
||||
if useTemplate {
|
||||
tmpl = template.Must(template.New(name).Parse(endpoint))
|
||||
}
|
||||
|
||||
r := func(ctx context.Context) *resty.Request {
|
||||
return client.R(ctx).SetResult(singleType)
|
||||
}
|
||||
|
||||
pr := func(ctx context.Context) *resty.Request {
|
||||
return client.R(ctx).SetResult(pagedType)
|
||||
}
|
||||
|
||||
return &Resource{name, endpoint, useTemplate, tmpl, r, pr}
|
||||
}
|
||||
|
||||
func (r Resource) render(data ...interface{}) (string, error) {
|
||||
if data == nil {
|
||||
return "", NewError("Cannot template endpoint with <nil> data")
|
||||
}
|
||||
out := ""
|
||||
buf := bytes.NewBufferString(out)
|
||||
|
||||
var substitutions interface{}
|
||||
if len(data) == 1 {
|
||||
substitutions = struct{ ID interface{} }{data[0]}
|
||||
} else if len(data) == 2 {
|
||||
substitutions = struct {
|
||||
ID interface{}
|
||||
SecondID interface{}
|
||||
}{data[0], data[1]}
|
||||
} else {
|
||||
return "", NewError("Too many arguments to render template (expected 1 or 2)")
|
||||
}
|
||||
if err := r.endpointTemplate.Execute(buf, substitutions); err != nil {
|
||||
return "", NewError(err)
|
||||
}
|
||||
return buf.String(), nil
|
||||
}
|
||||
|
||||
// endpointWithID will return the rendered endpoint string for the resource with provided id
|
||||
func (r Resource) endpointWithID(id ...int) (string, error) {
|
||||
if !r.isTemplate {
|
||||
return r.endpoint, nil
|
||||
}
|
||||
data := make([]interface{}, len(id))
|
||||
for i, v := range id {
|
||||
data[i] = v
|
||||
}
|
||||
return r.render(data...)
|
||||
}
|
||||
|
||||
// Endpoint will return the non-templated endpoint string for resource
|
||||
func (r Resource) Endpoint() (string, error) {
|
||||
if r.isTemplate {
|
||||
return "", NewError(fmt.Sprintf("Tried to get endpoint for %s without providing data for template", r.name))
|
||||
}
|
||||
return r.endpoint, nil
|
||||
}
|
||||
|
|
@ -0,0 +1,208 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Stackscript represents a Linode StackScript
|
||||
type Stackscript struct {
|
||||
CreatedStr string `json:"created"`
|
||||
UpdatedStr string `json:"updated"`
|
||||
|
||||
ID int `json:"id"`
|
||||
Username string `json:"username"`
|
||||
Label string `json:"label"`
|
||||
Description string `json:"description"`
|
||||
Images []string `json:"images"`
|
||||
DeploymentsTotal int `json:"deployments_total"`
|
||||
DeploymentsActive int `json:"deployments_active"`
|
||||
IsPublic bool `json:"is_public"`
|
||||
Created *time.Time `json:"-"`
|
||||
Updated *time.Time `json:"-"`
|
||||
RevNote string `json:"rev_note"`
|
||||
Script string `json:"script"`
|
||||
UserDefinedFields *[]StackscriptUDF `json:"user_defined_fields"`
|
||||
UserGravatarID string `json:"user_gravatar_id"`
|
||||
}
|
||||
|
||||
// StackscriptUDF define a single variable that is accepted by a Stackscript
|
||||
type StackscriptUDF struct {
|
||||
// A human-readable label for the field that will serve as the input prompt for entering the value during deployment.
|
||||
Label string `json:"label"`
|
||||
|
||||
// The name of the field.
|
||||
Name string `json:"name"`
|
||||
|
||||
// An example value for the field.
|
||||
Example string `json:"example"`
|
||||
|
||||
// A list of acceptable single values for the field.
|
||||
OneOf string `json:"oneOf,omitempty"`
|
||||
|
||||
// A list of acceptable values for the field in any quantity, combination or order.
|
||||
ManyOf string `json:"manyOf,omitempty"`
|
||||
|
||||
// The default value. If not specified, this value will be used.
|
||||
Default string `json:"default,omitempty"`
|
||||
}
|
||||
|
||||
// StackscriptCreateOptions fields are those accepted by CreateStackscript
|
||||
type StackscriptCreateOptions struct {
|
||||
Label string `json:"label"`
|
||||
Description string `json:"description"`
|
||||
Images []string `json:"images"`
|
||||
IsPublic bool `json:"is_public"`
|
||||
RevNote string `json:"rev_note"`
|
||||
Script string `json:"script"`
|
||||
}
|
||||
|
||||
// StackscriptUpdateOptions fields are those accepted by UpdateStackscript
|
||||
type StackscriptUpdateOptions StackscriptCreateOptions
|
||||
|
||||
// GetCreateOptions converts a Stackscript to StackscriptCreateOptions for use in CreateStackscript
|
||||
func (i Stackscript) GetCreateOptions() StackscriptCreateOptions {
|
||||
return StackscriptCreateOptions{
|
||||
Label: i.Label,
|
||||
Description: i.Description,
|
||||
Images: i.Images,
|
||||
IsPublic: i.IsPublic,
|
||||
RevNote: i.RevNote,
|
||||
Script: i.Script,
|
||||
}
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts a Stackscript to StackscriptUpdateOptions for use in UpdateStackscript
|
||||
func (i Stackscript) GetUpdateOptions() StackscriptUpdateOptions {
|
||||
return StackscriptUpdateOptions{
|
||||
Label: i.Label,
|
||||
Description: i.Description,
|
||||
Images: i.Images,
|
||||
IsPublic: i.IsPublic,
|
||||
RevNote: i.RevNote,
|
||||
Script: i.Script,
|
||||
}
|
||||
}
|
||||
|
||||
// StackscriptsPagedResponse represents a paginated Stackscript API response
|
||||
type StackscriptsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Stackscript `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for Stackscript
|
||||
func (StackscriptsPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.StackScripts.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends Stackscripts when processing paginated Stackscript responses
|
||||
func (resp *StackscriptsPagedResponse) appendData(r *StackscriptsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListStackscripts lists Stackscripts
|
||||
func (c *Client) ListStackscripts(ctx context.Context, opts *ListOptions) ([]Stackscript, error) {
|
||||
response := StackscriptsPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (i *Stackscript) fixDates() *Stackscript {
|
||||
i.Created, _ = parseDates(i.CreatedStr)
|
||||
i.Updated, _ = parseDates(i.UpdatedStr)
|
||||
return i
|
||||
}
|
||||
|
||||
// GetStackscript gets the Stackscript with the provided ID
|
||||
func (c *Client) GetStackscript(ctx context.Context, id int) (*Stackscript, error) {
|
||||
e, err := c.StackScripts.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).
|
||||
SetResult(&Stackscript{}).
|
||||
Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Stackscript).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateStackscript creates a StackScript
|
||||
func (c *Client) CreateStackscript(ctx context.Context, createOpts StackscriptCreateOptions) (*Stackscript, error) {
|
||||
var body string
|
||||
e, err := c.StackScripts.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&Stackscript{})
|
||||
|
||||
if bodyData, err := json.Marshal(createOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Stackscript).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateStackscript updates the StackScript with the specified id
|
||||
func (c *Client) UpdateStackscript(ctx context.Context, id int, updateOpts StackscriptUpdateOptions) (*Stackscript, error) {
|
||||
var body string
|
||||
e, err := c.StackScripts.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
req := c.R(ctx).SetResult(&Stackscript{})
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Stackscript).fixDates(), nil
|
||||
}
|
||||
|
||||
// DeleteStackscript deletes the StackScript with the specified id
|
||||
func (c *Client) DeleteStackscript(ctx context.Context, id int) error {
|
||||
e, err := c.StackScripts.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,88 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Ticket represents a support ticket object
|
||||
type Ticket struct {
|
||||
ID int `json:"id"`
|
||||
Attachments []string `json:"attachments"`
|
||||
Closed *time.Time `json:"-"`
|
||||
Description string `json:"description"`
|
||||
Entity *TicketEntity `json:"entity"`
|
||||
GravatarID string `json:"gravatar_id"`
|
||||
Opened *time.Time `json:"-"`
|
||||
OpenedBy string `json:"opened_by"`
|
||||
Status TicketStatus `json:"status"`
|
||||
Summary string `json:"summary"`
|
||||
Updated *time.Time `json:"-"`
|
||||
UpdatedBy string `json:"updated_by"`
|
||||
}
|
||||
|
||||
// TicketEntity refers a ticket to a specific entity
|
||||
type TicketEntity struct {
|
||||
ID int `json:"id"`
|
||||
Label string `json:"label"`
|
||||
Type string `json:"type"`
|
||||
URL string `json:"url"`
|
||||
}
|
||||
|
||||
// TicketStatus constants start with Ticket and include Linode API Ticket Status values
|
||||
type TicketStatus string
|
||||
|
||||
// TicketStatus constants reflect the current status of a Ticket
|
||||
const (
|
||||
TicketNew TicketStatus = "new"
|
||||
TicketClosed TicketStatus = "closed"
|
||||
TicketOpen TicketStatus = "open"
|
||||
)
|
||||
|
||||
// TicketsPagedResponse represents a paginated ticket API response
|
||||
type TicketsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Ticket `json:"data"`
|
||||
}
|
||||
|
||||
func (TicketsPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Tickets.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
func (resp *TicketsPagedResponse) appendData(r *TicketsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListTickets returns a collection of Support Tickets on the Account. Support Tickets
|
||||
// can be both tickets opened with Linode for support, as well as tickets generated by
|
||||
// Linode regarding the Account. This collection includes all Support Tickets generated
|
||||
// on the Account, with open tickets returned first.
|
||||
func (c *Client) ListTickets(ctx context.Context, opts *ListOptions) ([]Ticket, error) {
|
||||
response := TicketsPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// GetTicket gets a Support Ticket on the Account with the specified ID
|
||||
func (c *Client) GetTicket(ctx context.Context, id int) (*Ticket, error) {
|
||||
e, err := c.Tickets.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).
|
||||
SetResult(&Ticket{}).
|
||||
Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Ticket), nil
|
||||
}
|
||||
|
|
@ -0,0 +1,219 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// Tag represents a Tag object
|
||||
type Tag struct {
|
||||
Label string `json:"label"`
|
||||
}
|
||||
|
||||
// TaggedObject represents a Tagged Object object
|
||||
type TaggedObject struct {
|
||||
Type string `json:"type"`
|
||||
RawData json.RawMessage `json:"data"`
|
||||
Data interface{} `json:"-"`
|
||||
}
|
||||
|
||||
// SortedObjects currently only includes Instances
|
||||
type SortedObjects struct {
|
||||
Instances []Instance
|
||||
Domains []Domain
|
||||
Volumes []Volume
|
||||
NodeBalancers []NodeBalancer
|
||||
/*
|
||||
StackScripts []Stackscript
|
||||
*/
|
||||
}
|
||||
|
||||
// TaggedObjectList are a list of TaggedObjects, as returning by ListTaggedObjects
|
||||
type TaggedObjectList []TaggedObject
|
||||
|
||||
// TagCreateOptions fields are those accepted by CreateTag
|
||||
type TagCreateOptions struct {
|
||||
Label string `json:"label"`
|
||||
Linodes []int `json:"linodes,omitempty"`
|
||||
Domains []int `json:"domains,omitempty"`
|
||||
Volumes []int `json:"volumes,omitempty"`
|
||||
NodeBalancers []int `json:"nodebalancers,omitempty"`
|
||||
}
|
||||
|
||||
// GetCreateOptions converts a Tag to TagCreateOptions for use in CreateTag
|
||||
func (i Tag) GetCreateOptions() (o TagCreateOptions) {
|
||||
o.Label = i.Label
|
||||
return
|
||||
}
|
||||
|
||||
// TaggedObjectsPagedResponse represents a paginated Tag API response
|
||||
type TaggedObjectsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []TaggedObject `json:"data"`
|
||||
}
|
||||
|
||||
// TagsPagedResponse represents a paginated Tag API response
|
||||
type TagsPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Tag `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for Tag
|
||||
func (TagsPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Tags.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for Tag
|
||||
func (TaggedObjectsPagedResponse) endpointWithID(c *Client, id string) string {
|
||||
endpoint, err := c.Tags.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
endpoint = fmt.Sprintf("%s/%s", endpoint, id)
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends Tags when processing paginated Tag responses
|
||||
func (resp *TagsPagedResponse) appendData(r *TagsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// appendData appends TaggedObjects when processing paginated TaggedObjects responses
|
||||
func (resp *TaggedObjectsPagedResponse) appendData(r *TaggedObjectsPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListTags lists Tags
|
||||
func (c *Client) ListTags(ctx context.Context, opts *ListOptions) ([]Tag, error) {
|
||||
response := TagsPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixData stores an object of the type defined by Type in Data using RawData
|
||||
func (i *TaggedObject) fixData() (*TaggedObject, error) {
|
||||
switch i.Type {
|
||||
case "linode":
|
||||
obj := Instance{}
|
||||
if err := json.Unmarshal(i.RawData, &obj); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
i.Data = obj
|
||||
case "nodebalancer":
|
||||
obj := NodeBalancer{}
|
||||
if err := json.Unmarshal(i.RawData, &obj); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
i.Data = obj
|
||||
case "domain":
|
||||
obj := Domain{}
|
||||
if err := json.Unmarshal(i.RawData, &obj); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
i.Data = obj
|
||||
case "volume":
|
||||
obj := Volume{}
|
||||
if err := json.Unmarshal(i.RawData, &obj); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
i.Data = obj
|
||||
}
|
||||
|
||||
return i, nil
|
||||
}
|
||||
|
||||
// ListTaggedObjects lists Tagged Objects
|
||||
func (c *Client) ListTaggedObjects(ctx context.Context, label string, opts *ListOptions) (TaggedObjectList, error) {
|
||||
response := TaggedObjectsPagedResponse{}
|
||||
err := c.listHelperWithID(ctx, &response, label, opts)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
for i := range response.Data {
|
||||
if _, err := response.Data[i].fixData(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// SortedObjects converts a list of TaggedObjects into a Sorted Objects struct, for easier access
|
||||
func (t TaggedObjectList) SortedObjects() (SortedObjects, error) {
|
||||
so := SortedObjects{}
|
||||
for _, o := range t {
|
||||
switch o.Type {
|
||||
case "linode":
|
||||
if instance, ok := o.Data.(Instance); ok {
|
||||
so.Instances = append(so.Instances, instance)
|
||||
} else {
|
||||
return so, errors.New("Expected an Instance when Type was \"linode\"")
|
||||
}
|
||||
case "domain":
|
||||
if domain, ok := o.Data.(Domain); ok {
|
||||
so.Domains = append(so.Domains, domain)
|
||||
} else {
|
||||
return so, errors.New("Expected a Domain when Type was \"domain\"")
|
||||
}
|
||||
case "volume":
|
||||
if volume, ok := o.Data.(Volume); ok {
|
||||
so.Volumes = append(so.Volumes, volume)
|
||||
} else {
|
||||
return so, errors.New("Expected an Volume when Type was \"volume\"")
|
||||
}
|
||||
case "nodebalancer":
|
||||
if nodebalancer, ok := o.Data.(NodeBalancer); ok {
|
||||
so.NodeBalancers = append(so.NodeBalancers, nodebalancer)
|
||||
} else {
|
||||
return so, errors.New("Expected an NodeBalancer when Type was \"nodebalancer\"")
|
||||
}
|
||||
}
|
||||
}
|
||||
return so, nil
|
||||
}
|
||||
|
||||
// CreateTag creates a Tag
|
||||
func (c *Client) CreateTag(ctx context.Context, createOpts TagCreateOptions) (*Tag, error) {
|
||||
var body string
|
||||
e, err := c.Tags.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&Tag{})
|
||||
|
||||
if bodyData, err := json.Marshal(createOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Tag), nil
|
||||
}
|
||||
|
||||
// DeleteTag deletes the Tag with the specified id
|
||||
func (c *Client) DeleteTag(ctx context.Context, label string) error {
|
||||
e, err := c.Tags.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, label)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,167 @@
|
|||
// +build ignore
|
||||
|
||||
package linodego
|
||||
|
||||
/*
|
||||
- replace "Template" with "NameOfResource"
|
||||
- replace "template" with "nameOfResource"
|
||||
- copy template_test.go and do the same
|
||||
- When updating Template structs,
|
||||
- use pointers where ever null'able would have a different meaning if the wrapper
|
||||
supplied "" or 0 instead
|
||||
- Add "NameOfResource" to client.go, resources.go, pagination.go
|
||||
*/
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// Template represents a Template object
|
||||
type Template struct {
|
||||
ID int `json:"id"`
|
||||
// UpdatedStr string `json:"updated"`
|
||||
// Updated *time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// TemplateCreateOptions fields are those accepted by CreateTemplate
|
||||
type TemplateCreateOptions struct {
|
||||
}
|
||||
|
||||
// TemplateUpdateOptions fields are those accepted by UpdateTemplate
|
||||
type TemplateUpdateOptions struct {
|
||||
}
|
||||
|
||||
// GetCreateOptions converts a Template to TemplateCreateOptions for use in CreateTemplate
|
||||
func (i Template) GetCreateOptions() (o TemplateCreateOptions) {
|
||||
// o.Label = i.Label
|
||||
// o.Description = copyString(i.Description)
|
||||
return
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts a Template to TemplateUpdateOptions for use in UpdateTemplate
|
||||
func (i Template) GetUpdateOptions() (o TemplateUpdateOptions) {
|
||||
// o.Label = i.Label
|
||||
// o.Description = copyString(i.Description)
|
||||
return
|
||||
}
|
||||
|
||||
// TemplatesPagedResponse represents a paginated Template API response
|
||||
type TemplatesPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Template `json:"data"`
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for Template
|
||||
func (TemplatesPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Templates.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends Templates when processing paginated Template responses
|
||||
func (resp *TemplatesPagedResponse) appendData(r *TemplatesPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListTemplates lists Templates
|
||||
func (c *Client) ListTemplates(ctx context.Context, opts *ListOptions) ([]Template, error) {
|
||||
response := TemplatesPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (i *Template) fixDates() *Template {
|
||||
// i.Created, _ = parseDates(i.CreatedStr)
|
||||
// i.Updated, _ = parseDates(i.UpdatedStr)
|
||||
return i
|
||||
}
|
||||
|
||||
// GetTemplate gets the template with the provided ID
|
||||
func (c *Client) GetTemplate(ctx context.Context, id int) (*Template, error) {
|
||||
e, err := c.Templates.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&Template{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Template).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateTemplate creates a Template
|
||||
func (c *Client) CreateTemplate(ctx context.Context, createOpts TemplateCreateOptions) (*Template, error) {
|
||||
var body string
|
||||
e, err := c.Templates.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req := c.R(ctx).SetResult(&Template{})
|
||||
|
||||
if bodyData, err := json.Marshal(createOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Template).fixDates(), nil
|
||||
}
|
||||
|
||||
// UpdateTemplate updates the Template with the specified id
|
||||
func (c *Client) UpdateTemplate(ctx context.Context, id int, updateOpts TemplateUpdateOptions) (*Template, error) {
|
||||
var body string
|
||||
e, err := c.Templates.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
req := c.R(ctx).SetResult(&Template{})
|
||||
|
||||
if bodyData, err := json.Marshal(updateOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Template).fixDates(), nil
|
||||
}
|
||||
|
||||
// DeleteTemplate deletes the Template with the specified id
|
||||
func (c *Client) DeleteTemplate(ctx context.Context, id int) error {
|
||||
e, err := c.Templates.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,90 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// LinodeType represents a linode type object
|
||||
type LinodeType struct {
|
||||
ID string `json:"id"`
|
||||
Disk int `json:"disk"`
|
||||
Class LinodeTypeClass `json:"class"` // enum: nanode, standard, highmem, dedicated
|
||||
Price *LinodePrice `json:"price"`
|
||||
Label string `json:"label"`
|
||||
Addons *LinodeAddons `json:"addons"`
|
||||
NetworkOut int `json:"network_out"`
|
||||
Memory int `json:"memory"`
|
||||
Transfer int `json:"transfer"`
|
||||
VCPUs int `json:"vcpus"`
|
||||
}
|
||||
|
||||
// LinodePrice represents a linode type price object
|
||||
type LinodePrice struct {
|
||||
Hourly float32 `json:"hourly"`
|
||||
Monthly float32 `json:"monthly"`
|
||||
}
|
||||
|
||||
// LinodeBackupsAddon represents a linode backups addon object
|
||||
type LinodeBackupsAddon struct {
|
||||
Price *LinodePrice `json:"price"`
|
||||
}
|
||||
|
||||
// LinodeAddons represent the linode addons object
|
||||
type LinodeAddons struct {
|
||||
Backups *LinodeBackupsAddon `json:"backups"`
|
||||
}
|
||||
|
||||
// LinodeTypeClass constants start with Class and include Linode API Instance Type Classes
|
||||
type LinodeTypeClass string
|
||||
|
||||
// LinodeTypeClass contants are the Instance Type Classes that an Instance Type can be assigned
|
||||
const (
|
||||
ClassNanode LinodeTypeClass = "nanode"
|
||||
ClassStandard LinodeTypeClass = "standard"
|
||||
ClassHighmem LinodeTypeClass = "highmem"
|
||||
ClassDedicated LinodeTypeClass = "dedicated"
|
||||
)
|
||||
|
||||
// LinodeTypesPagedResponse represents a linode types API response for listing
|
||||
type LinodeTypesPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []LinodeType `json:"data"`
|
||||
}
|
||||
|
||||
func (LinodeTypesPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Types.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
func (resp *LinodeTypesPagedResponse) appendData(r *LinodeTypesPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListTypes lists linode types
|
||||
func (c *Client) ListTypes(ctx context.Context, opts *ListOptions) ([]LinodeType, error) {
|
||||
response := LinodeTypesPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// GetType gets the type with the provided ID
|
||||
func (c *Client) GetType(ctx context.Context, typeID string) (*LinodeType, error) {
|
||||
e, err := c.Types.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%s", e, typeID)
|
||||
|
||||
r, err := coupleAPIErrors(c.Types.R(ctx).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*LinodeType), nil
|
||||
}
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
package linodego
|
||||
|
||||
import "time"
|
||||
|
||||
const (
|
||||
dateLayout = "2006-01-02T15:04:05"
|
||||
)
|
||||
|
||||
func parseDates(dateStr string) (*time.Time, error) {
|
||||
d, err := time.Parse(dateLayout, dateStr)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &d, nil
|
||||
}
|
||||
|
|
@ -0,0 +1,299 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// VolumeStatus indicates the status of the Volume
|
||||
type VolumeStatus string
|
||||
|
||||
const (
|
||||
// VolumeCreating indicates the Volume is being created and is not yet available for use
|
||||
VolumeCreating VolumeStatus = "creating"
|
||||
|
||||
// VolumeActive indicates the Volume is online and available for use
|
||||
VolumeActive VolumeStatus = "active"
|
||||
|
||||
// VolumeResizing indicates the Volume is in the process of upgrading its current capacity
|
||||
VolumeResizing VolumeStatus = "resizing"
|
||||
|
||||
// VolumeContactSupport indicates there is a problem with the Volume. A support ticket must be opened to resolve the issue
|
||||
VolumeContactSupport VolumeStatus = "contact_support"
|
||||
)
|
||||
|
||||
// Volume represents a linode volume object
|
||||
type Volume struct {
|
||||
CreatedStr string `json:"created"`
|
||||
UpdatedStr string `json:"updated"`
|
||||
|
||||
ID int `json:"id"`
|
||||
Label string `json:"label"`
|
||||
Status VolumeStatus `json:"status"`
|
||||
Region string `json:"region"`
|
||||
Size int `json:"size"`
|
||||
LinodeID *int `json:"linode_id"`
|
||||
FilesystemPath string `json:"filesystem_path"`
|
||||
Tags []string `json:"tags"`
|
||||
Created time.Time `json:"-"`
|
||||
Updated time.Time `json:"-"`
|
||||
}
|
||||
|
||||
// VolumeCreateOptions fields are those accepted by CreateVolume
|
||||
type VolumeCreateOptions struct {
|
||||
Label string `json:"label,omitempty"`
|
||||
Region string `json:"region,omitempty"`
|
||||
LinodeID int `json:"linode_id,omitempty"`
|
||||
ConfigID int `json:"config_id,omitempty"`
|
||||
// The Volume's size, in GiB. Minimum size is 10GiB, maximum size is 10240GiB. A "0" value will result in the default size.
|
||||
Size int `json:"size,omitempty"`
|
||||
// An array of tags applied to this object. Tags are for organizational purposes only.
|
||||
Tags []string `json:"tags"`
|
||||
}
|
||||
|
||||
// VolumeUpdateOptions fields are those accepted by UpdateVolume
|
||||
type VolumeUpdateOptions struct {
|
||||
Label string `json:"label,omitempty"`
|
||||
Tags *[]string `json:"tags,omitempty"`
|
||||
}
|
||||
|
||||
// VolumeAttachOptions fields are those accepted by AttachVolume
|
||||
type VolumeAttachOptions struct {
|
||||
LinodeID int `json:"linode_id"`
|
||||
ConfigID int `json:"config_id,omitempty"`
|
||||
}
|
||||
|
||||
// VolumesPagedResponse represents a linode API response for listing of volumes
|
||||
type VolumesPagedResponse struct {
|
||||
*PageOptions
|
||||
Data []Volume `json:"data"`
|
||||
}
|
||||
|
||||
// GetUpdateOptions converts a Volume to VolumeUpdateOptions for use in UpdateVolume
|
||||
func (v Volume) GetUpdateOptions() (updateOpts VolumeUpdateOptions) {
|
||||
updateOpts.Label = v.Label
|
||||
updateOpts.Tags = &v.Tags
|
||||
return
|
||||
}
|
||||
|
||||
// GetCreateOptions converts a Volume to VolumeCreateOptions for use in CreateVolume
|
||||
func (v Volume) GetCreateOptions() (createOpts VolumeCreateOptions) {
|
||||
createOpts.Label = v.Label
|
||||
createOpts.Tags = v.Tags
|
||||
createOpts.Region = v.Region
|
||||
createOpts.Size = v.Size
|
||||
if v.LinodeID != nil && *v.LinodeID > 0 {
|
||||
createOpts.LinodeID = *v.LinodeID
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// endpoint gets the endpoint URL for Volume
|
||||
func (VolumesPagedResponse) endpoint(c *Client) string {
|
||||
endpoint, err := c.Volumes.Endpoint()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return endpoint
|
||||
}
|
||||
|
||||
// appendData appends Volumes when processing paginated Volume responses
|
||||
func (resp *VolumesPagedResponse) appendData(r *VolumesPagedResponse) {
|
||||
resp.Data = append(resp.Data, r.Data...)
|
||||
}
|
||||
|
||||
// ListVolumes lists Volumes
|
||||
func (c *Client) ListVolumes(ctx context.Context, opts *ListOptions) ([]Volume, error) {
|
||||
response := VolumesPagedResponse{}
|
||||
err := c.listHelper(ctx, &response, opts)
|
||||
for i := range response.Data {
|
||||
response.Data[i].fixDates()
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return response.Data, nil
|
||||
}
|
||||
|
||||
// fixDates converts JSON timestamps to Go time.Time values
|
||||
func (v *Volume) fixDates() *Volume {
|
||||
if parsed, err := parseDates(v.CreatedStr); err != nil {
|
||||
v.Created = *parsed
|
||||
}
|
||||
if parsed, err := parseDates(v.UpdatedStr); err != nil {
|
||||
v.Updated = *parsed
|
||||
}
|
||||
return v
|
||||
}
|
||||
|
||||
// GetVolume gets the template with the provided ID
|
||||
func (c *Client) GetVolume(ctx context.Context, id int) (*Volume, error) {
|
||||
e, err := c.Volumes.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&Volume{}).Get(e))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Volume).fixDates(), nil
|
||||
}
|
||||
|
||||
// AttachVolume attaches a volume to a Linode instance
|
||||
func (c *Client) AttachVolume(ctx context.Context, id int, options *VolumeAttachOptions) (*Volume, error) {
|
||||
body := ""
|
||||
if bodyData, err := json.Marshal(options); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
e, err := c.Volumes.Endpoint()
|
||||
if err != nil {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
e = fmt.Sprintf("%s/%d/attach", e, id)
|
||||
resp, err := coupleAPIErrors(c.R(ctx).
|
||||
SetResult(&Volume{}).
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return resp.Result().(*Volume).fixDates(), nil
|
||||
}
|
||||
|
||||
// CreateVolume creates a Linode Volume
|
||||
func (c *Client) CreateVolume(ctx context.Context, createOpts VolumeCreateOptions) (*Volume, error) {
|
||||
body := ""
|
||||
if bodyData, err := json.Marshal(createOpts); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
e, err := c.Volumes.Endpoint()
|
||||
if err != nil {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
resp, err := coupleAPIErrors(c.R(ctx).
|
||||
SetResult(&Volume{}).
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return resp.Result().(*Volume).fixDates(), nil
|
||||
}
|
||||
|
||||
// RenameVolume renames the label of a Linode volume
|
||||
// DEPRECATED: use UpdateVolume
|
||||
func (c *Client) RenameVolume(ctx context.Context, id int, label string) (*Volume, error) {
|
||||
updateOpts := VolumeUpdateOptions{Label: label}
|
||||
return c.UpdateVolume(ctx, id, updateOpts)
|
||||
}
|
||||
|
||||
// UpdateVolume updates the Volume with the specified id
|
||||
func (c *Client) UpdateVolume(ctx context.Context, id int, volume VolumeUpdateOptions) (*Volume, error) {
|
||||
var body string
|
||||
e, err := c.Volumes.Endpoint()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
req := c.R(ctx).SetResult(&Volume{})
|
||||
|
||||
if bodyData, err := json.Marshal(volume); err == nil {
|
||||
body = string(bodyData)
|
||||
} else {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
|
||||
r, err := coupleAPIErrors(req.
|
||||
SetBody(body).
|
||||
Put(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return r.Result().(*Volume).fixDates(), nil
|
||||
}
|
||||
|
||||
// CloneVolume clones a Linode volume
|
||||
func (c *Client) CloneVolume(ctx context.Context, id int, label string) (*Volume, error) {
|
||||
body := fmt.Sprintf("{\"label\":\"%s\"}", label)
|
||||
|
||||
e, err := c.Volumes.Endpoint()
|
||||
if err != nil {
|
||||
return nil, NewError(err)
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d/clone", e, id)
|
||||
|
||||
resp, err := coupleAPIErrors(c.R(ctx).
|
||||
SetResult(&Volume{}).
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return resp.Result().(*Volume).fixDates(), nil
|
||||
}
|
||||
|
||||
// DetachVolume detaches a Linode volume
|
||||
func (c *Client) DetachVolume(ctx context.Context, id int) error {
|
||||
body := ""
|
||||
|
||||
e, err := c.Volumes.Endpoint()
|
||||
if err != nil {
|
||||
return NewError(err)
|
||||
}
|
||||
|
||||
e = fmt.Sprintf("%s/%d/detach", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
// ResizeVolume resizes an instance to new Linode type
|
||||
func (c *Client) ResizeVolume(ctx context.Context, id int, size int) error {
|
||||
body := fmt.Sprintf("{\"size\": %d}", size)
|
||||
|
||||
e, err := c.Volumes.Endpoint()
|
||||
if err != nil {
|
||||
return NewError(err)
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d/resize", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).
|
||||
SetBody(body).
|
||||
Post(e))
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
// DeleteVolume deletes the Volume with the specified id
|
||||
func (c *Client) DeleteVolume(ctx context.Context, id int) error {
|
||||
e, err := c.Volumes.Endpoint()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
e = fmt.Sprintf("%s/%d", e, id)
|
||||
|
||||
_, err = coupleAPIErrors(c.R(ctx).Delete(e))
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,273 @@
|
|||
package linodego
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"log"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
// WaitForInstanceStatus waits for the Linode instance to reach the desired state
|
||||
// before returning. It will timeout with an error after timeoutSeconds.
|
||||
func (client Client) WaitForInstanceStatus(ctx context.Context, instanceID int, status InstanceStatus, timeoutSeconds int) (*Instance, error) {
|
||||
ctx, cancel := context.WithTimeout(ctx, time.Duration(timeoutSeconds)*time.Second)
|
||||
defer cancel()
|
||||
|
||||
ticker := time.NewTicker(client.millisecondsPerPoll * time.Millisecond)
|
||||
defer ticker.Stop()
|
||||
for {
|
||||
select {
|
||||
case <-ticker.C:
|
||||
instance, err := client.GetInstance(ctx, instanceID)
|
||||
if err != nil {
|
||||
return instance, err
|
||||
}
|
||||
complete := (instance.Status == status)
|
||||
|
||||
if complete {
|
||||
return instance, nil
|
||||
}
|
||||
case <-ctx.Done():
|
||||
return nil, fmt.Errorf("Error waiting for Instance %d status %s: %s", instanceID, status, ctx.Err())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// WaitForInstanceDiskStatus waits for the Linode instance disk to reach the desired state
|
||||
// before returning. It will timeout with an error after timeoutSeconds.
|
||||
func (client Client) WaitForInstanceDiskStatus(ctx context.Context, instanceID int, diskID int, status DiskStatus, timeoutSeconds int) (*InstanceDisk, error) {
|
||||
ctx, cancel := context.WithTimeout(ctx, time.Duration(timeoutSeconds)*time.Second)
|
||||
defer cancel()
|
||||
|
||||
ticker := time.NewTicker(client.millisecondsPerPoll * time.Millisecond)
|
||||
defer ticker.Stop()
|
||||
for {
|
||||
select {
|
||||
case <-ticker.C:
|
||||
// GetInstanceDisk will 404 on newly created disks. use List instead.
|
||||
// disk, err := client.GetInstanceDisk(ctx, instanceID, diskID)
|
||||
disks, err := client.ListInstanceDisks(ctx, instanceID, nil)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
for _, disk := range disks {
|
||||
if disk.ID == diskID {
|
||||
complete := (disk.Status == status)
|
||||
if complete {
|
||||
return &disk, nil
|
||||
}
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
case <-ctx.Done():
|
||||
return nil, fmt.Errorf("Error waiting for Instance %d Disk %d status %s: %s", instanceID, diskID, status, ctx.Err())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// WaitForVolumeStatus waits for the Volume to reach the desired state
|
||||
// before returning. It will timeout with an error after timeoutSeconds.
|
||||
func (client Client) WaitForVolumeStatus(ctx context.Context, volumeID int, status VolumeStatus, timeoutSeconds int) (*Volume, error) {
|
||||
ctx, cancel := context.WithTimeout(ctx, time.Duration(timeoutSeconds)*time.Second)
|
||||
defer cancel()
|
||||
|
||||
ticker := time.NewTicker(client.millisecondsPerPoll * time.Millisecond)
|
||||
defer ticker.Stop()
|
||||
for {
|
||||
select {
|
||||
case <-ticker.C:
|
||||
volume, err := client.GetVolume(ctx, volumeID)
|
||||
if err != nil {
|
||||
return volume, err
|
||||
}
|
||||
complete := (volume.Status == status)
|
||||
|
||||
if complete {
|
||||
return volume, nil
|
||||
}
|
||||
case <-ctx.Done():
|
||||
return nil, fmt.Errorf("Error waiting for Volume %d status %s: %s", volumeID, status, ctx.Err())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// WaitForSnapshotStatus waits for the Snapshot to reach the desired state
|
||||
// before returning. It will timeout with an error after timeoutSeconds.
|
||||
func (client Client) WaitForSnapshotStatus(ctx context.Context, instanceID int, snapshotID int, status InstanceSnapshotStatus, timeoutSeconds int) (*InstanceSnapshot, error) {
|
||||
ctx, cancel := context.WithTimeout(ctx, time.Duration(timeoutSeconds)*time.Second)
|
||||
defer cancel()
|
||||
|
||||
ticker := time.NewTicker(client.millisecondsPerPoll * time.Millisecond)
|
||||
defer ticker.Stop()
|
||||
for {
|
||||
select {
|
||||
case <-ticker.C:
|
||||
snapshot, err := client.GetInstanceSnapshot(ctx, instanceID, snapshotID)
|
||||
if err != nil {
|
||||
return snapshot, err
|
||||
}
|
||||
complete := (snapshot.Status == status)
|
||||
|
||||
if complete {
|
||||
return snapshot, nil
|
||||
}
|
||||
case <-ctx.Done():
|
||||
return nil, fmt.Errorf("Error waiting for Instance %d Snapshot %d status %s: %s", instanceID, snapshotID, status, ctx.Err())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// WaitForVolumeLinodeID waits for the Volume to match the desired LinodeID
|
||||
// before returning. An active Instance will not immediately attach or detach a volume, so the
|
||||
// the LinodeID must be polled to determine volume readiness from the API.
|
||||
// WaitForVolumeLinodeID will timeout with an error after timeoutSeconds.
|
||||
func (client Client) WaitForVolumeLinodeID(ctx context.Context, volumeID int, linodeID *int, timeoutSeconds int) (*Volume, error) {
|
||||
ctx, cancel := context.WithTimeout(ctx, time.Duration(timeoutSeconds)*time.Second)
|
||||
defer cancel()
|
||||
|
||||
ticker := time.NewTicker(client.millisecondsPerPoll * time.Millisecond)
|
||||
defer ticker.Stop()
|
||||
for {
|
||||
select {
|
||||
case <-ticker.C:
|
||||
volume, err := client.GetVolume(ctx, volumeID)
|
||||
if err != nil {
|
||||
return volume, err
|
||||
}
|
||||
|
||||
if linodeID == nil && volume.LinodeID == nil {
|
||||
return volume, nil
|
||||
} else if linodeID == nil || volume.LinodeID == nil {
|
||||
// continue waiting
|
||||
} else if *volume.LinodeID == *linodeID {
|
||||
return volume, nil
|
||||
}
|
||||
|
||||
case <-ctx.Done():
|
||||
return nil, fmt.Errorf("Error waiting for Volume %d to have Instance %v: %s", volumeID, linodeID, ctx.Err())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// WaitForEventFinished waits for an entity action to reach the 'finished' state
|
||||
// before returning. It will timeout with an error after timeoutSeconds.
|
||||
// If the event indicates a failure both the failed event and the error will be returned.
|
||||
func (client Client) WaitForEventFinished(ctx context.Context, id interface{}, entityType EntityType, action EventAction, minStart time.Time, timeoutSeconds int) (*Event, error) {
|
||||
titledEntityType := strings.Title(string(entityType))
|
||||
filter, _ := json.Marshal(map[string]interface{}{
|
||||
// Entity is not filtered by the API
|
||||
// Perhaps one day they will permit Entity ID/Type filtering.
|
||||
// We'll have to verify these values manually, for now.
|
||||
//"entity": map[string]interface{}{
|
||||
// "id": fmt.Sprintf("%v", id),
|
||||
// "type": entityType,
|
||||
//},
|
||||
|
||||
// Nor is action
|
||||
//"action": action,
|
||||
|
||||
// Created is not correctly filtered by the API
|
||||
// We'll have to verify these values manually, for now.
|
||||
//"created": map[string]interface{}{
|
||||
// "+gte": minStart.Format(time.RFC3339),
|
||||
//},
|
||||
|
||||
// With potentially 1000+ events coming back, we should filter on something
|
||||
"seen": false,
|
||||
|
||||
// Float the latest events to page 1
|
||||
"+order_by": "created",
|
||||
"+order": "desc",
|
||||
})
|
||||
|
||||
// Optimistically restrict results to page 1. We should remove this when more
|
||||
// precise filtering options exist.
|
||||
listOptions := NewListOptions(1, string(filter))
|
||||
|
||||
ctx, cancel := context.WithTimeout(ctx, time.Duration(timeoutSeconds)*time.Second)
|
||||
defer cancel()
|
||||
|
||||
if deadline, ok := ctx.Deadline(); ok {
|
||||
duration := time.Until(deadline)
|
||||
log.Printf("[INFO] Waiting %d seconds for %s events since %v for %s %v", int(duration.Seconds()), action, minStart, titledEntityType, id)
|
||||
}
|
||||
|
||||
ticker := time.NewTicker(client.millisecondsPerPoll * time.Millisecond)
|
||||
defer ticker.Stop()
|
||||
for {
|
||||
select {
|
||||
case <-ticker.C:
|
||||
|
||||
events, err := client.ListEvents(ctx, listOptions)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// If there are events for this instance + action, inspect them
|
||||
for _, event := range events {
|
||||
if event.Action != action {
|
||||
// log.Println("action mismatch", event.Action, action)
|
||||
continue
|
||||
}
|
||||
if event.Entity == nil || event.Entity.Type != entityType {
|
||||
// log.Println("type mismatch", event.Entity.Type, entityType)
|
||||
continue
|
||||
}
|
||||
|
||||
var entID string
|
||||
|
||||
switch event.Entity.ID.(type) {
|
||||
case float64, float32:
|
||||
entID = fmt.Sprintf("%.f", event.Entity.ID)
|
||||
case int:
|
||||
entID = strconv.Itoa(event.Entity.ID.(int))
|
||||
default:
|
||||
entID = fmt.Sprintf("%v", event.Entity.ID)
|
||||
}
|
||||
|
||||
var findID string
|
||||
switch id.(type) {
|
||||
case float64, float32:
|
||||
findID = fmt.Sprintf("%.f", id)
|
||||
case int:
|
||||
findID = strconv.Itoa(id.(int))
|
||||
default:
|
||||
findID = fmt.Sprintf("%v", id)
|
||||
}
|
||||
|
||||
if entID != findID {
|
||||
// log.Println("id mismatch", entID, findID)
|
||||
continue
|
||||
}
|
||||
|
||||
// @TODO(displague) This event.Created check shouldn't be needed, but it appears
|
||||
// that the ListEvents method is not populating it correctly
|
||||
if event.Created == nil {
|
||||
log.Printf("[WARN] event.Created is nil when API returned: %#+v", event.CreatedStr)
|
||||
} else if *event.Created != minStart && !event.Created.After(minStart) {
|
||||
// Not the event we were looking for
|
||||
// log.Println(event.Created, "is not >=", minStart)
|
||||
continue
|
||||
|
||||
}
|
||||
|
||||
if event.Status == EventFailed {
|
||||
return &event, fmt.Errorf("%s %v action %s failed", titledEntityType, id, action)
|
||||
} else if event.Status == EventScheduled {
|
||||
log.Printf("[INFO] %s %v action %s is scheduled", titledEntityType, id, action)
|
||||
} else if event.Status == EventFinished {
|
||||
log.Printf("[INFO] %s %v action %s is finished", titledEntityType, id, action)
|
||||
return &event, nil
|
||||
}
|
||||
// TODO(displague) can we bump the ticker to TimeRemaining/2 (>=1) when non-nil?
|
||||
log.Printf("[INFO] %s %v action %s is %s", titledEntityType, id, action, event.Status)
|
||||
}
|
||||
case <-ctx.Done():
|
||||
return nil, fmt.Errorf("Error waiting for Event Status '%s' of %s %v action '%s': %s", EventFinished, titledEntityType, id, action, ctx.Err())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright (c) 2017-2018 Tencent Ltd.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
264
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/client.go
generated
vendored
Normal file
264
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/client.go
generated
vendored
Normal file
|
|
@ -0,0 +1,264 @@
|
|||
package common
|
||||
|
||||
import (
|
||||
"encoding/hex"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"log"
|
||||
"net/http"
|
||||
"net/http/httputil"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/errors"
|
||||
tchttp "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/http"
|
||||
"github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile"
|
||||
)
|
||||
|
||||
type Client struct {
|
||||
region string
|
||||
httpClient *http.Client
|
||||
httpProfile *profile.HttpProfile
|
||||
profile *profile.ClientProfile
|
||||
credential *Credential
|
||||
signMethod string
|
||||
unsignedPayload bool
|
||||
debug bool
|
||||
}
|
||||
|
||||
func (c *Client) Send(request tchttp.Request, response tchttp.Response) (err error) {
|
||||
if request.GetDomain() == "" {
|
||||
domain := c.httpProfile.Endpoint
|
||||
if domain == "" {
|
||||
domain = tchttp.GetServiceDomain(request.GetService())
|
||||
}
|
||||
request.SetDomain(domain)
|
||||
}
|
||||
|
||||
if request.GetHttpMethod() == "" {
|
||||
request.SetHttpMethod(c.httpProfile.ReqMethod)
|
||||
}
|
||||
|
||||
tchttp.CompleteCommonParams(request, c.GetRegion())
|
||||
|
||||
if c.signMethod == "HmacSHA1" || c.signMethod == "HmacSHA256" {
|
||||
return c.sendWithSignatureV1(request, response)
|
||||
} else {
|
||||
return c.sendWithSignatureV3(request, response)
|
||||
}
|
||||
}
|
||||
|
||||
func (c *Client) sendWithSignatureV1(request tchttp.Request, response tchttp.Response) (err error) {
|
||||
// TODO: not an elegant way, it should be done in common params, but finally it need to refactor
|
||||
request.GetParams()["Language"] = c.profile.Language
|
||||
err = tchttp.ConstructParams(request)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
err = signRequest(request, c.credential, c.signMethod)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
httpRequest, err := http.NewRequest(request.GetHttpMethod(), request.GetUrl(), request.GetBodyReader())
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if request.GetHttpMethod() == "POST" {
|
||||
httpRequest.Header["Content-Type"] = []string{"application/x-www-form-urlencoded"}
|
||||
}
|
||||
if c.debug {
|
||||
outbytes, err := httputil.DumpRequest(httpRequest, true)
|
||||
if err != nil {
|
||||
log.Printf("[ERROR] dump request failed because %s", err)
|
||||
return err
|
||||
}
|
||||
log.Printf("[DEBUG] http request = %s", outbytes)
|
||||
}
|
||||
httpResponse, err := c.httpClient.Do(httpRequest)
|
||||
if err != nil {
|
||||
msg := fmt.Sprintf("Fail to get response because %s", err)
|
||||
return errors.NewTencentCloudSDKError("ClientError.NetworkError", msg, "")
|
||||
}
|
||||
err = tchttp.ParseFromHttpResponse(httpResponse, response)
|
||||
return err
|
||||
}
|
||||
|
||||
func (c *Client) sendWithSignatureV3(request tchttp.Request, response tchttp.Response) (err error) {
|
||||
headers := map[string]string{
|
||||
"Host": request.GetDomain(),
|
||||
"X-TC-Action": request.GetAction(),
|
||||
"X-TC-Version": request.GetVersion(),
|
||||
"X-TC-Timestamp": request.GetParams()["Timestamp"],
|
||||
"X-TC-RequestClient": request.GetParams()["RequestClient"],
|
||||
"X-TC-Language": c.profile.Language,
|
||||
}
|
||||
if c.region != "" {
|
||||
headers["X-TC-Region"] = c.region
|
||||
}
|
||||
if c.credential.Token != "" {
|
||||
headers["X-TC-Token"] = c.credential.Token
|
||||
}
|
||||
if request.GetHttpMethod() == "GET" {
|
||||
headers["Content-Type"] = "application/x-www-form-urlencoded"
|
||||
} else {
|
||||
headers["Content-Type"] = "application/json"
|
||||
}
|
||||
|
||||
// start signature v3 process
|
||||
|
||||
// build canonical request string
|
||||
httpRequestMethod := request.GetHttpMethod()
|
||||
canonicalURI := "/"
|
||||
canonicalQueryString := ""
|
||||
if httpRequestMethod == "GET" {
|
||||
err = tchttp.ConstructParams(request)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
params := make(map[string]string)
|
||||
for key, value := range request.GetParams() {
|
||||
params[key] = value
|
||||
}
|
||||
delete(params, "Action")
|
||||
delete(params, "Version")
|
||||
delete(params, "Nonce")
|
||||
delete(params, "Region")
|
||||
delete(params, "RequestClient")
|
||||
delete(params, "Timestamp")
|
||||
canonicalQueryString = tchttp.GetUrlQueriesEncoded(params)
|
||||
}
|
||||
canonicalHeaders := fmt.Sprintf("content-type:%s\nhost:%s\n", headers["Content-Type"], headers["Host"])
|
||||
signedHeaders := "content-type;host"
|
||||
requestPayload := ""
|
||||
if httpRequestMethod == "POST" {
|
||||
b, err := json.Marshal(request)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
requestPayload = string(b)
|
||||
}
|
||||
hashedRequestPayload := ""
|
||||
if c.unsignedPayload {
|
||||
hashedRequestPayload = sha256hex("UNSIGNED-PAYLOAD")
|
||||
headers["X-TC-Content-SHA256"] = "UNSIGNED-PAYLOAD"
|
||||
} else {
|
||||
hashedRequestPayload = sha256hex(requestPayload)
|
||||
}
|
||||
canonicalRequest := fmt.Sprintf("%s\n%s\n%s\n%s\n%s\n%s",
|
||||
httpRequestMethod,
|
||||
canonicalURI,
|
||||
canonicalQueryString,
|
||||
canonicalHeaders,
|
||||
signedHeaders,
|
||||
hashedRequestPayload)
|
||||
//log.Println("canonicalRequest:", canonicalRequest)
|
||||
|
||||
// build string to sign
|
||||
algorithm := "TC3-HMAC-SHA256"
|
||||
requestTimestamp := headers["X-TC-Timestamp"]
|
||||
timestamp, _ := strconv.ParseInt(requestTimestamp, 10, 64)
|
||||
t := time.Unix(timestamp, 0).UTC()
|
||||
// must be the format 2006-01-02, ref to package time for more info
|
||||
date := t.Format("2006-01-02")
|
||||
credentialScope := fmt.Sprintf("%s/%s/tc3_request", date, request.GetService())
|
||||
hashedCanonicalRequest := sha256hex(canonicalRequest)
|
||||
string2sign := fmt.Sprintf("%s\n%s\n%s\n%s",
|
||||
algorithm,
|
||||
requestTimestamp,
|
||||
credentialScope,
|
||||
hashedCanonicalRequest)
|
||||
//log.Println("string2sign", string2sign)
|
||||
|
||||
// sign string
|
||||
secretDate := hmacsha256(date, "TC3"+c.credential.SecretKey)
|
||||
secretService := hmacsha256(request.GetService(), secretDate)
|
||||
secretKey := hmacsha256("tc3_request", secretService)
|
||||
signature := hex.EncodeToString([]byte(hmacsha256(string2sign, secretKey)))
|
||||
//log.Println("signature", signature)
|
||||
|
||||
// build authorization
|
||||
authorization := fmt.Sprintf("%s Credential=%s/%s, SignedHeaders=%s, Signature=%s",
|
||||
algorithm,
|
||||
c.credential.SecretId,
|
||||
credentialScope,
|
||||
signedHeaders,
|
||||
signature)
|
||||
//log.Println("authorization", authorization)
|
||||
|
||||
headers["Authorization"] = authorization
|
||||
url := "https://" + request.GetDomain() + request.GetPath()
|
||||
if canonicalQueryString != "" {
|
||||
url = url + "?" + canonicalQueryString
|
||||
}
|
||||
httpRequest, err := http.NewRequest(httpRequestMethod, url, strings.NewReader(requestPayload))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
for k, v := range headers {
|
||||
httpRequest.Header[k] = []string{v}
|
||||
}
|
||||
if c.debug {
|
||||
outbytes, err := httputil.DumpRequest(httpRequest, true)
|
||||
if err != nil {
|
||||
log.Printf("[ERROR] dump request failed because %s", err)
|
||||
return err
|
||||
}
|
||||
log.Printf("[DEBUG] http request = %s", outbytes)
|
||||
}
|
||||
httpResponse, err := c.httpClient.Do(httpRequest)
|
||||
if err != nil {
|
||||
msg := fmt.Sprintf("Fail to get response because %s", err)
|
||||
return errors.NewTencentCloudSDKError("ClientError.NetworkError", msg, "")
|
||||
}
|
||||
err = tchttp.ParseFromHttpResponse(httpResponse, response)
|
||||
return err
|
||||
}
|
||||
|
||||
func (c *Client) GetRegion() string {
|
||||
return c.region
|
||||
}
|
||||
|
||||
func (c *Client) Init(region string) *Client {
|
||||
c.httpClient = &http.Client{}
|
||||
c.region = region
|
||||
c.signMethod = "TC3-HMAC-SHA256"
|
||||
c.debug = false
|
||||
log.SetFlags(log.LstdFlags | log.Lshortfile)
|
||||
return c
|
||||
}
|
||||
|
||||
func (c *Client) WithSecretId(secretId, secretKey string) *Client {
|
||||
c.credential = NewCredential(secretId, secretKey)
|
||||
return c
|
||||
}
|
||||
|
||||
func (c *Client) WithCredential(cred *Credential) *Client {
|
||||
c.credential = cred
|
||||
return c
|
||||
}
|
||||
|
||||
func (c *Client) WithProfile(clientProfile *profile.ClientProfile) *Client {
|
||||
c.profile = clientProfile
|
||||
c.signMethod = clientProfile.SignMethod
|
||||
c.unsignedPayload = clientProfile.UnsignedPayload
|
||||
c.httpProfile = clientProfile.HttpProfile
|
||||
c.httpClient.Timeout = time.Duration(c.httpProfile.ReqTimeout) * time.Second
|
||||
return c
|
||||
}
|
||||
|
||||
func (c *Client) WithSignatureMethod(method string) *Client {
|
||||
c.signMethod = method
|
||||
return c
|
||||
}
|
||||
|
||||
func (c *Client) WithHttpTransport(transport http.RoundTripper) *Client {
|
||||
c.httpClient.Transport = transport
|
||||
return c
|
||||
}
|
||||
|
||||
func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error) {
|
||||
client = &Client{}
|
||||
client.Init(region).WithSecretId(secretId, secretKey)
|
||||
return
|
||||
}
|
||||
58
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/credentials.go
generated
vendored
Normal file
58
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/credentials.go
generated
vendored
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
package common
|
||||
|
||||
type Credential struct {
|
||||
SecretId string
|
||||
SecretKey string
|
||||
Token string
|
||||
}
|
||||
|
||||
func NewCredential(secretId, secretKey string) *Credential {
|
||||
return &Credential{
|
||||
SecretId: secretId,
|
||||
SecretKey: secretKey,
|
||||
}
|
||||
}
|
||||
|
||||
func NewTokenCredential(secretId, secretKey, token string) *Credential {
|
||||
return &Credential{
|
||||
SecretId: secretId,
|
||||
SecretKey: secretKey,
|
||||
Token: token,
|
||||
}
|
||||
}
|
||||
|
||||
func (c *Credential) GetCredentialParams() map[string]string {
|
||||
p := map[string]string{
|
||||
"SecretId": c.SecretId,
|
||||
}
|
||||
if c.Token != "" {
|
||||
p["Token"] = c.Token
|
||||
}
|
||||
return p
|
||||
}
|
||||
|
||||
// Nowhere use them and we haven't well designed these structures and
|
||||
// underlying method, which leads to the situation that it is hard to
|
||||
// refactor it to interfaces.
|
||||
// Hence they are removed and merged into Credential.
|
||||
|
||||
//type TokenCredential struct {
|
||||
// SecretId string
|
||||
// SecretKey string
|
||||
// Token string
|
||||
//}
|
||||
|
||||
//func NewTokenCredential(secretId, secretKey, token string) *TokenCredential {
|
||||
// return &TokenCredential{
|
||||
// SecretId: secretId,
|
||||
// SecretKey: secretKey,
|
||||
// Token: token,
|
||||
// }
|
||||
//}
|
||||
|
||||
//func (c *TokenCredential) GetCredentialParams() map[string]string {
|
||||
// return map[string]string{
|
||||
// "SecretId": c.SecretId,
|
||||
// "Token": c.Token,
|
||||
// }
|
||||
//}
|
||||
35
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/errors/errors.go
generated
vendored
Normal file
35
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/errors/errors.go
generated
vendored
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
package errors
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
)
|
||||
|
||||
type TencentCloudSDKError struct {
|
||||
Code string
|
||||
Message string
|
||||
RequestId string
|
||||
}
|
||||
|
||||
func (e *TencentCloudSDKError) Error() string {
|
||||
return fmt.Sprintf("[TencentCloudSDKError] Code=%s, Message=%s, RequestId=%s", e.Code, e.Message, e.RequestId)
|
||||
}
|
||||
|
||||
func NewTencentCloudSDKError(code, message, requestId string) error {
|
||||
return &TencentCloudSDKError{
|
||||
Code: code,
|
||||
Message: message,
|
||||
RequestId: requestId,
|
||||
}
|
||||
}
|
||||
|
||||
func (e *TencentCloudSDKError) GetCode() string {
|
||||
return e.Code
|
||||
}
|
||||
|
||||
func (e *TencentCloudSDKError) GetMessage() string {
|
||||
return e.Message
|
||||
}
|
||||
|
||||
func (e *TencentCloudSDKError) GetRequestId() string {
|
||||
return e.RequestId
|
||||
}
|
||||
233
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/http/request.go
generated
vendored
Normal file
233
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/http/request.go
generated
vendored
Normal file
|
|
@ -0,0 +1,233 @@
|
|||
package common
|
||||
|
||||
import (
|
||||
"io"
|
||||
//"log"
|
||||
"math/rand"
|
||||
"net/url"
|
||||
"reflect"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
const (
|
||||
POST = "POST"
|
||||
GET = "GET"
|
||||
|
||||
RootDomain = "tencentcloudapi.com"
|
||||
Path = "/"
|
||||
)
|
||||
|
||||
type Request interface {
|
||||
GetAction() string
|
||||
GetBodyReader() io.Reader
|
||||
GetDomain() string
|
||||
GetHttpMethod() string
|
||||
GetParams() map[string]string
|
||||
GetPath() string
|
||||
GetService() string
|
||||
GetUrl() string
|
||||
GetVersion() string
|
||||
SetDomain(string)
|
||||
SetHttpMethod(string)
|
||||
}
|
||||
|
||||
type BaseRequest struct {
|
||||
httpMethod string
|
||||
domain string
|
||||
path string
|
||||
params map[string]string
|
||||
formParams map[string]string
|
||||
|
||||
service string
|
||||
version string
|
||||
action string
|
||||
}
|
||||
|
||||
func (r *BaseRequest) GetAction() string {
|
||||
return r.action
|
||||
}
|
||||
|
||||
func (r *BaseRequest) GetHttpMethod() string {
|
||||
return r.httpMethod
|
||||
}
|
||||
|
||||
func (r *BaseRequest) GetParams() map[string]string {
|
||||
return r.params
|
||||
}
|
||||
|
||||
func (r *BaseRequest) GetPath() string {
|
||||
return r.path
|
||||
}
|
||||
|
||||
func (r *BaseRequest) GetDomain() string {
|
||||
return r.domain
|
||||
}
|
||||
|
||||
func (r *BaseRequest) SetDomain(domain string) {
|
||||
r.domain = domain
|
||||
}
|
||||
|
||||
func (r *BaseRequest) SetHttpMethod(method string) {
|
||||
switch strings.ToUpper(method) {
|
||||
case POST:
|
||||
{
|
||||
r.httpMethod = POST
|
||||
}
|
||||
case GET:
|
||||
{
|
||||
r.httpMethod = GET
|
||||
}
|
||||
default:
|
||||
{
|
||||
r.httpMethod = GET
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (r *BaseRequest) GetService() string {
|
||||
return r.service
|
||||
}
|
||||
|
||||
func (r *BaseRequest) GetUrl() string {
|
||||
if r.httpMethod == GET {
|
||||
return "https://" + r.domain + r.path + "?" + GetUrlQueriesEncoded(r.params)
|
||||
} else if r.httpMethod == POST {
|
||||
return "https://" + r.domain + r.path
|
||||
} else {
|
||||
return ""
|
||||
}
|
||||
}
|
||||
|
||||
func (r *BaseRequest) GetVersion() string {
|
||||
return r.version
|
||||
}
|
||||
|
||||
func GetUrlQueriesEncoded(params map[string]string) string {
|
||||
values := url.Values{}
|
||||
for key, value := range params {
|
||||
if value != "" {
|
||||
values.Add(key, value)
|
||||
}
|
||||
}
|
||||
return values.Encode()
|
||||
}
|
||||
|
||||
func (r *BaseRequest) GetBodyReader() io.Reader {
|
||||
if r.httpMethod == POST {
|
||||
s := GetUrlQueriesEncoded(r.params)
|
||||
return strings.NewReader(s)
|
||||
} else {
|
||||
return strings.NewReader("")
|
||||
}
|
||||
}
|
||||
|
||||
func (r *BaseRequest) Init() *BaseRequest {
|
||||
r.domain = ""
|
||||
r.path = Path
|
||||
r.params = make(map[string]string)
|
||||
r.formParams = make(map[string]string)
|
||||
return r
|
||||
}
|
||||
|
||||
func (r *BaseRequest) WithApiInfo(service, version, action string) *BaseRequest {
|
||||
r.service = service
|
||||
r.version = version
|
||||
r.action = action
|
||||
return r
|
||||
}
|
||||
|
||||
func GetServiceDomain(service string) (domain string) {
|
||||
domain = service + "." + RootDomain
|
||||
return
|
||||
}
|
||||
|
||||
func CompleteCommonParams(request Request, region string) {
|
||||
params := request.GetParams()
|
||||
params["Region"] = region
|
||||
if request.GetVersion() != "" {
|
||||
params["Version"] = request.GetVersion()
|
||||
}
|
||||
params["Action"] = request.GetAction()
|
||||
params["Timestamp"] = strconv.FormatInt(time.Now().Unix(), 10)
|
||||
params["Nonce"] = strconv.Itoa(rand.Int())
|
||||
params["RequestClient"] = "SDK_GO_3.0.83"
|
||||
}
|
||||
|
||||
func ConstructParams(req Request) (err error) {
|
||||
value := reflect.ValueOf(req).Elem()
|
||||
err = flatStructure(value, req, "")
|
||||
//log.Printf("[DEBUG] params=%s", req.GetParams())
|
||||
return
|
||||
}
|
||||
|
||||
func flatStructure(value reflect.Value, request Request, prefix string) (err error) {
|
||||
//log.Printf("[DEBUG] reflect value: %v", value.Type())
|
||||
valueType := value.Type()
|
||||
for i := 0; i < valueType.NumField(); i++ {
|
||||
tag := valueType.Field(i).Tag
|
||||
nameTag, hasNameTag := tag.Lookup("name")
|
||||
if !hasNameTag {
|
||||
continue
|
||||
}
|
||||
field := value.Field(i)
|
||||
kind := field.Kind()
|
||||
if kind == reflect.Ptr && field.IsNil() {
|
||||
continue
|
||||
}
|
||||
if kind == reflect.Ptr {
|
||||
field = field.Elem()
|
||||
kind = field.Kind()
|
||||
}
|
||||
key := prefix + nameTag
|
||||
if kind == reflect.String {
|
||||
s := field.String()
|
||||
if s != "" {
|
||||
request.GetParams()[key] = s
|
||||
}
|
||||
} else if kind == reflect.Bool {
|
||||
request.GetParams()[key] = strconv.FormatBool(field.Bool())
|
||||
} else if kind == reflect.Int || kind == reflect.Int64 {
|
||||
request.GetParams()[key] = strconv.FormatInt(field.Int(), 10)
|
||||
} else if kind == reflect.Uint || kind == reflect.Uint64 {
|
||||
request.GetParams()[key] = strconv.FormatUint(field.Uint(), 10)
|
||||
} else if kind == reflect.Float64 {
|
||||
request.GetParams()[key] = strconv.FormatFloat(field.Float(), 'f', -1, 64)
|
||||
} else if kind == reflect.Slice {
|
||||
list := value.Field(i)
|
||||
for j := 0; j < list.Len(); j++ {
|
||||
vj := list.Index(j)
|
||||
key := prefix + nameTag + "." + strconv.Itoa(j)
|
||||
kind = vj.Kind()
|
||||
if kind == reflect.Ptr && vj.IsNil() {
|
||||
continue
|
||||
}
|
||||
if kind == reflect.Ptr {
|
||||
vj = vj.Elem()
|
||||
kind = vj.Kind()
|
||||
}
|
||||
if kind == reflect.String {
|
||||
request.GetParams()[key] = vj.String()
|
||||
} else if kind == reflect.Bool {
|
||||
request.GetParams()[key] = strconv.FormatBool(vj.Bool())
|
||||
} else if kind == reflect.Int || kind == reflect.Int64 {
|
||||
request.GetParams()[key] = strconv.FormatInt(vj.Int(), 10)
|
||||
} else if kind == reflect.Uint || kind == reflect.Uint64 {
|
||||
request.GetParams()[key] = strconv.FormatUint(vj.Uint(), 10)
|
||||
} else if kind == reflect.Float64 {
|
||||
request.GetParams()[key] = strconv.FormatFloat(vj.Float(), 'f', -1, 64)
|
||||
} else {
|
||||
if err = flatStructure(vj, request, key+"."); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if err = flatStructure(reflect.ValueOf(field.Interface()), request, prefix+nameTag+"."); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
return
|
||||
}
|
||||
81
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/http/response.go
generated
vendored
Normal file
81
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/http/response.go
generated
vendored
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
package common
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
//"log"
|
||||
"net/http"
|
||||
|
||||
"github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/errors"
|
||||
)
|
||||
|
||||
type Response interface {
|
||||
ParseErrorFromHTTPResponse(body []byte) error
|
||||
}
|
||||
|
||||
type BaseResponse struct {
|
||||
}
|
||||
|
||||
type ErrorResponse struct {
|
||||
Response struct {
|
||||
Error struct {
|
||||
Code string `json:"Code"`
|
||||
Message string `json:"Message"`
|
||||
} `json:"Error" omitempty`
|
||||
RequestId string `json:"RequestId"`
|
||||
} `json:"Response"`
|
||||
}
|
||||
|
||||
type DeprecatedAPIErrorResponse struct {
|
||||
Code int `json:"code"`
|
||||
Message string `json:"message"`
|
||||
CodeDesc string `json:"codeDesc"`
|
||||
}
|
||||
|
||||
func (r *BaseResponse) ParseErrorFromHTTPResponse(body []byte) (err error) {
|
||||
resp := &ErrorResponse{}
|
||||
err = json.Unmarshal(body, resp)
|
||||
if err != nil {
|
||||
msg := fmt.Sprintf("Fail to parse json content: %s, because: %s", body, err)
|
||||
return errors.NewTencentCloudSDKError("ClientError.ParseJsonError", msg, "")
|
||||
}
|
||||
if resp.Response.Error.Code != "" {
|
||||
return errors.NewTencentCloudSDKError(resp.Response.Error.Code, resp.Response.Error.Message, resp.Response.RequestId)
|
||||
}
|
||||
|
||||
deprecated := &DeprecatedAPIErrorResponse{}
|
||||
err = json.Unmarshal(body, deprecated)
|
||||
if err != nil {
|
||||
msg := fmt.Sprintf("Fail to parse json content: %s, because: %s", body, err)
|
||||
return errors.NewTencentCloudSDKError("ClientError.ParseJsonError", msg, "")
|
||||
}
|
||||
if deprecated.Code != 0 {
|
||||
return errors.NewTencentCloudSDKError(deprecated.CodeDesc, deprecated.Message, "")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func ParseFromHttpResponse(hr *http.Response, response Response) (err error) {
|
||||
defer hr.Body.Close()
|
||||
body, err := ioutil.ReadAll(hr.Body)
|
||||
if err != nil {
|
||||
msg := fmt.Sprintf("Fail to read response body because %s", err)
|
||||
return errors.NewTencentCloudSDKError("ClientError.IOError", msg, "")
|
||||
}
|
||||
if hr.StatusCode != 200 {
|
||||
msg := fmt.Sprintf("Request fail with http status code: %s, with body: %s", hr.Status, body)
|
||||
return errors.NewTencentCloudSDKError("ClientError.HttpStatusCodeError", msg, "")
|
||||
}
|
||||
//log.Printf("[DEBUG] Response Body=%s", body)
|
||||
err = response.ParseErrorFromHTTPResponse(body)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = json.Unmarshal(body, &response)
|
||||
if err != nil {
|
||||
msg := fmt.Sprintf("Fail to parse json content: %s, because: %s", body, err)
|
||||
return errors.NewTencentCloudSDKError("ClientError.ParseJsonError", msg, "")
|
||||
}
|
||||
return
|
||||
}
|
||||
21
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile/client_profile.go
generated
vendored
Normal file
21
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile/client_profile.go
generated
vendored
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
package profile
|
||||
|
||||
type ClientProfile struct {
|
||||
HttpProfile *HttpProfile
|
||||
// Valid choices: HmacSHA1, HmacSHA256, TC3-HMAC-SHA256.
|
||||
// Default value is TC3-HMAC-SHA256.
|
||||
SignMethod string
|
||||
UnsignedPayload bool
|
||||
// Valid choices: zh-CN, en-US.
|
||||
// Default value is zh-CN.
|
||||
Language string
|
||||
}
|
||||
|
||||
func NewClientProfile() *ClientProfile {
|
||||
return &ClientProfile{
|
||||
HttpProfile: NewHttpProfile(),
|
||||
SignMethod: "TC3-HMAC-SHA256",
|
||||
UnsignedPayload: false,
|
||||
Language: "zh-CN",
|
||||
}
|
||||
}
|
||||
17
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile/http_profile.go
generated
vendored
Normal file
17
vendor/github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile/http_profile.go
generated
vendored
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
package profile
|
||||
|
||||
type HttpProfile struct {
|
||||
ReqMethod string
|
||||
ReqTimeout int
|
||||
Endpoint string
|
||||
Protocol string
|
||||
}
|
||||
|
||||
func NewHttpProfile() *HttpProfile {
|
||||
return &HttpProfile{
|
||||
ReqMethod: "POST",
|
||||
ReqTimeout: 60,
|
||||
Endpoint: "",
|
||||
Protocol: "HTTPS",
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue