@itentialopensource/adapter-amazon_route53 0.4.6 → 0.4.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AUTH.md +40 -16
- package/CHANGELOG.md +16 -0
- package/TAB2.md +42 -16
- package/package.json +2 -2
- package/propertiesSchema.json +23 -10
- package/refs?service=git-upload-pack +0 -0
- package/report/adapterInfo.json +2 -2
- package/report/auto-adapter-openapi.json +3054 -0
- package/sampleProperties.json +3 -1
package/AUTH.md
CHANGED
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
## Authenticating
|
|
1
|
+
## Authenticating AWS Route53 Adapter
|
|
2
2
|
|
|
3
|
-
This document will go through the steps for authenticating the
|
|
3
|
+
This document will go through the steps for authenticating the AWS Route53 adapter with AWS Signature 4 Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>.
|
|
4
4
|
|
|
5
5
|
### AWS Authentication
|
|
6
|
-
The
|
|
6
|
+
The AWS Route53 adapter requires AWS Authentication therefore the `auth_method` should be set to `aws_authentication`. The adapter utilizes AWS signature 4 authentication. There are three mechanisms for doing this. There is a brief description in this section and more information in the specific section for each authentication.
|
|
7
7
|
|
|
8
|
-
The first way is using a "service" account and its AWS keys to
|
|
8
|
+
The first way is using a "service" account and its AWS keys to authenticate as that account. In this case, you will get the aws_access_key, aws_secret_key, and aws_session_token from AWS and configure them into the adapter service instance as shown below.
|
|
9
9
|
|
|
10
|
-
The second way is using AWS STS. this still requires a "service" account and its AWS keys to
|
|
10
|
+
The second way is using AWS STS. this still requires a "service" account and its AWS keys to authenticate as that account. In this case, you will get the aws_access_key, aws_secret_key, and aws_session_token from AWS and configure them into the adapter service instance as shown below. In addition, you will provide STS paramaters in the workflow tasks that tell the adapter the role you want used on the particular call.
|
|
11
11
|
|
|
12
12
|
The third authentication method is to use an IAM role. With this method, you do not need any authentication keys as the adapter will utilize an "internal" AWS call to get the things that it needs for authentication. Since the adapter needs to make the call to this "internal" AWS IP address, the IAP server needs to be where it has access to that address or you will not be able to use this method.
|
|
13
13
|
|
|
14
14
|
If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
|
|
15
15
|
|
|
16
16
|
### AWS Signature 4 Service Account Authentication
|
|
17
|
-
|
|
17
|
+
This can also be referred to as standard credential signing using an Adapter Role or Pod Role.
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Provide access key and secret key in adapter service instance configuration (Adapter Role). Those credentials are used to sign all calls. If no access key and/or secret key are provided, it will use AWS Environment variables (which in Saas is the Pod Role) to sign all calls. If this role has no permission to make the call, the call will fail with authentication issues.
|
|
20
20
|
|
|
21
21
|
STEPS
|
|
22
|
-
1. Ensure you have access to a
|
|
22
|
+
1. Ensure you have access to a AWS Route53 server and that it is running
|
|
23
23
|
2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
|
|
24
24
|
3. Use the properties below for the ```properties.authentication``` field
|
|
25
25
|
```json
|
|
@@ -30,11 +30,16 @@ STEPS
|
|
|
30
30
|
"aws_session_token": "aws_session_token"
|
|
31
31
|
}
|
|
32
32
|
```
|
|
33
|
-
you can leave all of the other properties in the authentication section, they will not be used for
|
|
33
|
+
you can leave all of the other properties in the authentication section, they will not be used for AWS Route53 authentication.
|
|
34
34
|
4. Restart the adapter. If your properties were set correctly, the adapter should go online.
|
|
35
35
|
|
|
36
36
|
### AWS Security Token Service
|
|
37
|
-
The
|
|
37
|
+
The AWS Route53 adapter also supports AWS Security Token Service (STS) Authentication. This can also be referred to as standard credential but then STS assume role based on STS Params on Task.
|
|
38
|
+
Adapter Role => Task Role(s) or Pod Role => Task Role(s).
|
|
39
|
+
|
|
40
|
+
Provide access key and secret key in adapter service instance configuration (Adapter Role). Will use these credentials on the assume role request to assume a different role defined in the STSParams on the task (Task Role). The Task Role will then be used to sign the call to AWS. The Adapter Role has to have the right to assume the Task Role or the call will fail. If no access key and/or secret key are provided, it will use AWS Environment variables (which is Saas is the Pod Role) to attempt the assume a different role defined in the STSParams on the task (Task Role). The Task Role will then be used to sign the call to AWS. The Pod Role has to have the right to assume the Task Role or the call will fail.
|
|
41
|
+
|
|
42
|
+
For using this authentication, you need to use the calls in the Adapter that have the STSRole suffix on them and pass the STS information into the method. You will still need to provide the relevant `aws_secret_key` and `aws_access_key` as described above. Below is an example of the data required in the `sts` tasks:
|
|
38
43
|
|
|
39
44
|
```json
|
|
40
45
|
{
|
|
@@ -43,19 +48,38 @@ The Amazon Route53 adapter also supports AWS Security Token Service (STS) Authen
|
|
|
43
48
|
}
|
|
44
49
|
```
|
|
45
50
|
|
|
46
|
-
The AWS STS Authentication goes to the AWS STS Service endpoint in order to validate that the primary "service" account the adapter has authenticated with has the permission to assume the role. This call is made to sts.amazonaws.com or a regional sts sevice (e.g. sts.us-east-1.amazonaws.com). By default traffic to these endpoints will go out through the Internet. In the case where you would prefer these route through your network, it is possible to change the STS config for the adapter.
|
|
51
|
+
The AWS STS Authentication goes to the AWS STS Service endpoint in order to validate that the primary "service" account the adapter has authenticated with has the permission to assume the role. This call is made to sts.amazonaws.com or a regional sts sevice (e.g. sts.us-east-1.amazonaws.com). By default traffic to these endpoints will go out through the Internet. In the case where you would prefer these route through your network, it is possible to change the STS config for the adapter.
|
|
52
|
+
|
|
53
|
+
The proxy field should point to the AWS loadbalancer or a proxy server that forwards to AWS STS. In Itential Cloud, this can be NAT'd to your network. In addition to this, you may need to set the endpoint in order to have the STS SSL certificate validated successfully. By default the adapter will use sts regional servers. If the loadbalancer and proxy are set up for that you should be fine. If however, they point to the global STS service (sts.amazonaws.com) You will need to set the global as the endpoint or the STS certificate will be rejected due to the hosts not matching.
|
|
54
|
+
|
|
55
|
+
Region can be important as it is the region in which the STS assume role request will be processed. Each AWS partition may have one primary region for STS. In our tests, we have found that for the standard partition the STS region should be set to us-east-t but this is configurable should your primary region be different or you are working in a different AWS partition.
|
|
56
|
+
|
|
57
|
+
If doing cross organizational role assumption it is recommended to have an external id that is agreed upon for further security. THis external id can be provided in the aws_sts properties (global) or defined in the STS Params object on the task (dynamic).
|
|
47
58
|
|
|
48
59
|
```json
|
|
49
60
|
"authentication": {
|
|
50
61
|
"aws_sts": {
|
|
62
|
+
"region": "us-east-1",
|
|
51
63
|
"endpoint": "<sts certificate endpoint>",
|
|
52
64
|
"proxy": "<proxy/loadbalancer ip>",
|
|
65
|
+
"externalId": "<sts external id>"
|
|
53
66
|
}
|
|
54
67
|
}
|
|
55
68
|
```
|
|
56
69
|
|
|
57
70
|
### AWS IAM Role
|
|
58
|
-
The
|
|
71
|
+
The AWS Route53 adapter also supports AWS IAM Role Authentication. For using this authentication, you need to use the calls in the Adapter that have the STSRole suffix on them and provide the role's ARN in the RoleName variable. In addition to passing the IAM Role in the task, it is possible to set an IAM Role in the Service Instance Configuration by using the `aws_iam_role` property in the authentication section and providing the role's ARN.
|
|
72
|
+
|
|
73
|
+
This can also be referred to as role signing scenarios - need to have either a Task Role (roleName) and/or Adapter Role (aws_iam_role) to use ay of these scenarios.
|
|
74
|
+
|
|
75
|
+
Scenarios:
|
|
76
|
+
- IAM to internal AWS Server - either Task Role (roleName) or Adapter Role (aws_iam_role)
|
|
77
|
+
- Adapter Role (aws_iam_role) assumes Task Role (STSParams or roleName)
|
|
78
|
+
- IAM to internal AWS Server for Adapter Role
|
|
79
|
+
- AWS STS for assuming Task Role(s) using Adapter Role
|
|
80
|
+
- Pod Role assumes Adapter Role (aws_iam_role) assumes Task Role (STSParams, RoleName)
|
|
81
|
+
- AWS STS for assuming Adapter Role using AWS Environment (Pod Role)
|
|
82
|
+
- AWS STS for assuming Task Role(s) using Adapter Role
|
|
59
83
|
|
|
60
84
|
```json
|
|
61
85
|
"authentication": {
|
|
@@ -65,12 +89,12 @@ The Amazon Route53 adapter also supports AWS IAM Role Authentication. For using
|
|
|
65
89
|
```
|
|
66
90
|
|
|
67
91
|
### AMAZON STEPS FOR IAM ROLE
|
|
68
|
-
Increase number of hops if running IAP inside of docker on
|
|
92
|
+
Increase number of hops if running IAP inside of docker on Route53 instance
|
|
69
93
|
```bash
|
|
70
94
|
aws sso login --profile aws-bota-1
|
|
71
95
|
<export aws keys for CLI access>
|
|
72
96
|
|
|
73
|
-
|
|
97
|
+
aws ec2 modify-instance-metadata-options --instance-id i-0e150236026b7c45d --http-put-response-hop-limit 3 --http-endpoint enabled --region us-east-1
|
|
74
98
|
```
|
|
75
99
|
|
|
76
100
|
Create a new role and attach to it policies:
|
|
@@ -83,11 +107,11 @@ Trusted entity type: AWS service
|
|
|
83
107
|
Use Case: Route53
|
|
84
108
|
```
|
|
85
109
|
|
|
86
|
-
Add
|
|
110
|
+
Add desired policies to the role.
|
|
87
111
|
|
|
88
112
|
Save the role
|
|
89
113
|
|
|
90
|
-
Go back to Route53 and Actions->Security->Modify IAM Role, associate newly created role with your Route53 instance
|
|
114
|
+
Go back to your Route53 instance and Actions->Security->Modify IAM Role, associate newly created role with your Route53 instance
|
|
91
115
|
|
|
92
116
|
### Troubleshooting
|
|
93
117
|
- Make sure you copied over the correct access key, secret key and session token.
|
package/CHANGELOG.md
CHANGED
|
@@ -1,4 +1,20 @@
|
|
|
1
1
|
|
|
2
|
+
## 0.4.8 [11-12-2024]
|
|
3
|
+
|
|
4
|
+
* more auth changes
|
|
5
|
+
|
|
6
|
+
See merge request itentialopensource/adapters/adapter-amazon_route53!25
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## 0.4.7 [10-15-2024]
|
|
11
|
+
|
|
12
|
+
* Changes made at 2024.10.14_20:10PM
|
|
13
|
+
|
|
14
|
+
See merge request itentialopensource/adapters/adapter-amazon_route53!24
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
2
18
|
## 0.4.6 [09-30-2024]
|
|
3
19
|
|
|
4
20
|
* update auth docs
|
package/TAB2.md
CHANGED
|
@@ -11,26 +11,26 @@
|
|
|
11
11
|
## Specific Adapter Information
|
|
12
12
|
### Authentication
|
|
13
13
|
|
|
14
|
-
This document will go through the steps for authenticating the
|
|
14
|
+
This document will go through the steps for authenticating the AWS Route53 adapter with AWS Signature 4 Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>.
|
|
15
15
|
|
|
16
16
|
#### AWS Authentication
|
|
17
|
-
The
|
|
17
|
+
The AWS Route53 adapter requires AWS Authentication therefore the `auth_method` should be set to `aws_authentication`. The adapter utilizes AWS signature 4 authentication. There are three mechanisms for doing this. There is a brief description in this section and more information in the specific section for each authentication.
|
|
18
18
|
|
|
19
|
-
The first way is using a "service" account and its AWS keys to
|
|
19
|
+
The first way is using a "service" account and its AWS keys to authenticate as that account. In this case, you will get the aws_access_key, aws_secret_key, and aws_session_token from AWS and configure them into the adapter service instance as shown below.
|
|
20
20
|
|
|
21
|
-
The second way is using AWS STS. this still requires a "service" account and its AWS keys to
|
|
21
|
+
The second way is using AWS STS. this still requires a "service" account and its AWS keys to authenticate as that account. In this case, you will get the aws_access_key, aws_secret_key, and aws_session_token from AWS and configure them into the adapter service instance as shown below. In addition, you will provide STS paramaters in the workflow tasks that tell the adapter the role you want used on the particular call.
|
|
22
22
|
|
|
23
23
|
The third authentication method is to use an IAM role. With this method, you do not need any authentication keys as the adapter will utilize an "internal" AWS call to get the things that it needs for authentication. Since the adapter needs to make the call to this "internal" AWS IP address, the IAP server needs to be where it has access to that address or you will not be able to use this method.
|
|
24
24
|
|
|
25
25
|
If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
|
|
26
26
|
|
|
27
27
|
#### AWS Signature 4 Service Account Authentication
|
|
28
|
-
|
|
28
|
+
This can also be referred to as standard credential signing using an Adapter Role or Pod Role.
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
Provide access key and secret key in adapter service instance configuration (Adapter Role). Those credentials are used to sign all calls. If no access key and/or secret key are provided, it will use AWS Environment variables (which in Saas is the Pod Role) to sign all calls. If this role has no permission to make the call, the call will fail with authentication issues.
|
|
31
31
|
|
|
32
32
|
STEPS
|
|
33
|
-
1. Ensure you have access to a
|
|
33
|
+
1. Ensure you have access to a AWS Route53 server and that it is running
|
|
34
34
|
2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
|
|
35
35
|
3. Use the properties below for the ```properties.authentication``` field
|
|
36
36
|
```json
|
|
@@ -41,11 +41,16 @@ STEPS
|
|
|
41
41
|
"aws_session_token": "aws_session_token"
|
|
42
42
|
}
|
|
43
43
|
```
|
|
44
|
-
you can leave all of the other properties in the authentication section, they will not be used for
|
|
44
|
+
you can leave all of the other properties in the authentication section, they will not be used for AWS Route53 authentication.
|
|
45
45
|
4. Restart the adapter. If your properties were set correctly, the adapter should go online.
|
|
46
46
|
|
|
47
47
|
#### AWS Security Token Service
|
|
48
|
-
The
|
|
48
|
+
The AWS Route53 adapter also supports AWS Security Token Service (STS) Authentication. This can also be referred to as standard credential but then STS assume role based on STS Params on Task.
|
|
49
|
+
Adapter Role => Task Role(s) or Pod Role => Task Role(s).
|
|
50
|
+
|
|
51
|
+
Provide access key and secret key in adapter service instance configuration (Adapter Role). Will use these credentials on the assume role request to assume a different role defined in the STSParams on the task (Task Role). The Task Role will then be used to sign the call to AWS. The Adapter Role has to have the right to assume the Task Role or the call will fail. If no access key and/or secret key are provided, it will use AWS Environment variables (which is Saas is the Pod Role) to attempt the assume a different role defined in the STSParams on the task (Task Role). The Task Role will then be used to sign the call to AWS. The Pod Role has to have the right to assume the Task Role or the call will fail.
|
|
52
|
+
|
|
53
|
+
For using this authentication, you need to use the calls in the Adapter that have the STSRole suffix on them and pass the STS information into the method. You will still need to provide the relevant `aws_secret_key` and `aws_access_key` as described above. Below is an example of the data required in the `sts` tasks:
|
|
49
54
|
|
|
50
55
|
```json
|
|
51
56
|
{
|
|
@@ -54,19 +59,38 @@ The Amazon Route53 adapter also supports AWS Security Token Service (STS) Authen
|
|
|
54
59
|
}
|
|
55
60
|
```
|
|
56
61
|
|
|
57
|
-
The AWS STS Authentication goes to the AWS STS Service endpoint in order to validate that the primary "service" account the adapter has authenticated with has the permission to assume the role. This call is made to sts.amazonaws.com or a regional sts sevice (e.g. sts.us-east-1.amazonaws.com). By default traffic to these endpoints will go out through the Internet. In the case where you would prefer these route through your network, it is possible to change the STS config for the adapter.
|
|
62
|
+
The AWS STS Authentication goes to the AWS STS Service endpoint in order to validate that the primary "service" account the adapter has authenticated with has the permission to assume the role. This call is made to sts.amazonaws.com or a regional sts sevice (e.g. sts.us-east-1.amazonaws.com). By default traffic to these endpoints will go out through the Internet. In the case where you would prefer these route through your network, it is possible to change the STS config for the adapter.
|
|
63
|
+
|
|
64
|
+
The proxy field should point to the AWS loadbalancer or a proxy server that forwards to AWS STS. In Itential Cloud, this can be NAT'd to your network. In addition to this, you may need to set the endpoint in order to have the STS SSL certificate validated successfully. By default the adapter will use sts regional servers. If the loadbalancer and proxy are set up for that you should be fine. If however, they point to the global STS service (sts.amazonaws.com) You will need to set the global as the endpoint or the STS certificate will be rejected due to the hosts not matching.
|
|
65
|
+
|
|
66
|
+
Region can be important as it is the region in which the STS assume role request will be processed. Each AWS partition may have one primary region for STS. In our tests, we have found that for the standard partition the STS region should be set to us-east-t but this is configurable should your primary region be different or you are working in a different AWS partition.
|
|
67
|
+
|
|
68
|
+
If doing cross organizational role assumption it is recommended to have an external id that is agreed upon for further security. THis external id can be provided in the aws_sts properties (global) or defined in the STS Params object on the task (dynamic).
|
|
58
69
|
|
|
59
70
|
```json
|
|
60
71
|
"authentication": {
|
|
61
72
|
"aws_sts": {
|
|
73
|
+
"region": "us-east-1",
|
|
62
74
|
"endpoint": "<sts certificate endpoint>",
|
|
63
75
|
"proxy": "<proxy/loadbalancer ip>",
|
|
76
|
+
"externalId": "<sts external id>"
|
|
64
77
|
}
|
|
65
78
|
}
|
|
66
79
|
```
|
|
67
80
|
|
|
68
81
|
#### AWS IAM Role
|
|
69
|
-
The
|
|
82
|
+
The AWS Route53 adapter also supports AWS IAM Role Authentication. For using this authentication, you need to use the calls in the Adapter that have the STSRole suffix on them and provide the role's ARN in the RoleName variable. In addition to passing the IAM Role in the task, it is possible to set an IAM Role in the Service Instance Configuration by using the `aws_iam_role` property in the authentication section and providing the role's ARN.
|
|
83
|
+
|
|
84
|
+
This can also be referred to as role signing scenarios - need to have either a Task Role (roleName) and/or Adapter Role (aws_iam_role) to use ay of these scenarios.
|
|
85
|
+
|
|
86
|
+
Scenarios:
|
|
87
|
+
- IAM to internal AWS Server - either Task Role (roleName) or Adapter Role (aws_iam_role)
|
|
88
|
+
- Adapter Role (aws_iam_role) assumes Task Role (STSParams or roleName)
|
|
89
|
+
- IAM to internal AWS Server for Adapter Role
|
|
90
|
+
- AWS STS for assuming Task Role(s) using Adapter Role
|
|
91
|
+
- Pod Role assumes Adapter Role (aws_iam_role) assumes Task Role (STSParams, RoleName)
|
|
92
|
+
- AWS STS for assuming Adapter Role using AWS Environment (Pod Role)
|
|
93
|
+
- AWS STS for assuming Task Role(s) using Adapter Role
|
|
70
94
|
|
|
71
95
|
```json
|
|
72
96
|
"authentication": {
|
|
@@ -76,12 +100,12 @@ The Amazon Route53 adapter also supports AWS IAM Role Authentication. For using
|
|
|
76
100
|
```
|
|
77
101
|
|
|
78
102
|
#### AMAZON STEPS FOR IAM ROLE
|
|
79
|
-
Increase number of hops if running IAP inside of docker on
|
|
103
|
+
Increase number of hops if running IAP inside of docker on Route53 instance
|
|
80
104
|
```bash
|
|
81
105
|
aws sso login --profile aws-bota-1
|
|
82
106
|
<export aws keys for CLI access>
|
|
83
107
|
|
|
84
|
-
|
|
108
|
+
aws ec2 modify-instance-metadata-options --instance-id i-0e150236026b7c45d --http-put-response-hop-limit 3 --http-endpoint enabled --region us-east-1
|
|
85
109
|
```
|
|
86
110
|
|
|
87
111
|
Create a new role and attach to it policies:
|
|
@@ -94,11 +118,11 @@ Trusted entity type: AWS service
|
|
|
94
118
|
Use Case: Route53
|
|
95
119
|
```
|
|
96
120
|
|
|
97
|
-
Add
|
|
121
|
+
Add desired policies to the role.
|
|
98
122
|
|
|
99
123
|
Save the role
|
|
100
124
|
|
|
101
|
-
Go back to Route53 and Actions->Security->Modify IAM Role, associate newly created role with your Route53 instance
|
|
125
|
+
Go back to your Route53 instance and Actions->Security->Modify IAM Role, associate newly created role with your Route53 instance
|
|
102
126
|
|
|
103
127
|
#### Troubleshooting
|
|
104
128
|
- Make sure you copied over the correct access key, secret key and session token.
|
|
@@ -166,10 +190,12 @@ Sample Properties can be used to help you configure the adapter in the Itential
|
|
|
166
190
|
"aws_session_token": "aws_session_token",
|
|
167
191
|
"aws_iam_role": "",
|
|
168
192
|
"aws_sts": {
|
|
193
|
+
"region": "us-east-1",
|
|
169
194
|
"sslEnable": true,
|
|
170
195
|
"endpoint": "",
|
|
171
196
|
"proxy": "",
|
|
172
|
-
"proxyagent": ""
|
|
197
|
+
"proxyagent": "",
|
|
198
|
+
"externalId": ""
|
|
173
199
|
}
|
|
174
200
|
},
|
|
175
201
|
"healthcheck": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@itentialopensource/adapter-amazon_route53",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.8",
|
|
4
4
|
"description": "This adapter integrates with system described as: Amazon Route53.",
|
|
5
5
|
"main": "adapter.js",
|
|
6
6
|
"systemName": "Amazon AWS Route53",
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
"author": "Itential",
|
|
56
56
|
"homepage": "https://gitlab.com/itentialopensource/adapters/adapter-amazon_route53#readme",
|
|
57
57
|
"dependencies": {
|
|
58
|
-
"@itentialopensource/adapter-utils": "^5.
|
|
58
|
+
"@itentialopensource/adapter-utils": "^5.9.5",
|
|
59
59
|
"acorn": "^8.12.1",
|
|
60
60
|
"ajv": "^8.17.1",
|
|
61
61
|
"axios": "^1.7.4",
|
package/propertiesSchema.json
CHANGED
|
@@ -74,7 +74,7 @@
|
|
|
74
74
|
"boolean",
|
|
75
75
|
"string"
|
|
76
76
|
],
|
|
77
|
-
"description": "When true the metrics collected by the adapter will be stored in mongo or
|
|
77
|
+
"description": "When true the metrics collected by the adapter will be stored in mongo or in the adapter. If a full path is provided, metrics will be saved in the path provided.",
|
|
78
78
|
"default": false
|
|
79
79
|
},
|
|
80
80
|
"stub": {
|
|
@@ -221,7 +221,7 @@
|
|
|
221
221
|
"description": "How long a token is valid (in milliseconds), -1 (always get token), 0 use expiration returned with token",
|
|
222
222
|
"default": -1,
|
|
223
223
|
"minimum": -1,
|
|
224
|
-
"maximum":
|
|
224
|
+
"maximum": 86400000
|
|
225
225
|
},
|
|
226
226
|
"token_cache": {
|
|
227
227
|
"type": "string",
|
|
@@ -385,6 +385,14 @@
|
|
|
385
385
|
"aws_sts": {
|
|
386
386
|
"type": "object",
|
|
387
387
|
"properties": {
|
|
388
|
+
"region": {
|
|
389
|
+
"type": "string",
|
|
390
|
+
"description": "add a region to calls used for assume role",
|
|
391
|
+
"default": "",
|
|
392
|
+
"examples": [
|
|
393
|
+
"us-east-1"
|
|
394
|
+
]
|
|
395
|
+
},
|
|
388
396
|
"sslEnable": {
|
|
389
397
|
"type": "boolean",
|
|
390
398
|
"description": "This can disable the ssl for the sts requests",
|
|
@@ -416,6 +424,11 @@
|
|
|
416
424
|
"https",
|
|
417
425
|
"http"
|
|
418
426
|
]
|
|
427
|
+
},
|
|
428
|
+
"externalId": {
|
|
429
|
+
"type": "string",
|
|
430
|
+
"description": "define an external id to send with the sts request",
|
|
431
|
+
"default": ""
|
|
419
432
|
}
|
|
420
433
|
}
|
|
421
434
|
}
|
|
@@ -499,7 +512,7 @@
|
|
|
499
512
|
"type": "integer",
|
|
500
513
|
"description": "How often the healthcheck should run (in milliseconds).",
|
|
501
514
|
"default": 300000,
|
|
502
|
-
"minimum":
|
|
515
|
+
"minimum": 30000,
|
|
503
516
|
"maximum": 3600000
|
|
504
517
|
},
|
|
505
518
|
"protocol": {
|
|
@@ -1602,12 +1615,12 @@
|
|
|
1602
1615
|
"properties": {
|
|
1603
1616
|
"path": {
|
|
1604
1617
|
"type": "string",
|
|
1605
|
-
"description": "The fully qualified path of the call to
|
|
1618
|
+
"description": "The fully qualified path of the call to populate the cache (e.g. /rest/api/devices)",
|
|
1606
1619
|
"default": ""
|
|
1607
1620
|
},
|
|
1608
1621
|
"method": {
|
|
1609
1622
|
"type": "string",
|
|
1610
|
-
"description": "The method of the call to
|
|
1623
|
+
"description": "The method of the call to populate the cache",
|
|
1611
1624
|
"default": "GET"
|
|
1612
1625
|
},
|
|
1613
1626
|
"pagination": {
|
|
@@ -1644,7 +1657,7 @@
|
|
|
1644
1657
|
},
|
|
1645
1658
|
"query": {
|
|
1646
1659
|
"type": "object",
|
|
1647
|
-
"description": "The json object with query parameters of the call to
|
|
1660
|
+
"description": "The json object with query parameters of the call to populate the cache",
|
|
1648
1661
|
"additionalProperties": {
|
|
1649
1662
|
"type": [
|
|
1650
1663
|
"string",
|
|
@@ -1654,7 +1667,7 @@
|
|
|
1654
1667
|
},
|
|
1655
1668
|
"body": {
|
|
1656
1669
|
"type": "object",
|
|
1657
|
-
"description": "The json object with body of the call to
|
|
1670
|
+
"description": "The json object with body of the call to populate the cache",
|
|
1658
1671
|
"additionalProperties": {
|
|
1659
1672
|
"type": [
|
|
1660
1673
|
"string",
|
|
@@ -1664,7 +1677,7 @@
|
|
|
1664
1677
|
},
|
|
1665
1678
|
"headers": {
|
|
1666
1679
|
"type": "object",
|
|
1667
|
-
"description": "The json object with headers of the call to
|
|
1680
|
+
"description": "The json object with headers of the call to populate the cache",
|
|
1668
1681
|
"additionalProperties": {
|
|
1669
1682
|
"type": [
|
|
1670
1683
|
"string",
|
|
@@ -1683,7 +1696,7 @@
|
|
|
1683
1696
|
},
|
|
1684
1697
|
"requestFields": {
|
|
1685
1698
|
"type": "object",
|
|
1686
|
-
"description": "The json object with response fields of the call to
|
|
1699
|
+
"description": "The json object with response fields of the call to populate the cache",
|
|
1687
1700
|
"additionalProperties": {
|
|
1688
1701
|
"type": [
|
|
1689
1702
|
"string",
|
|
@@ -1699,7 +1712,7 @@
|
|
|
1699
1712
|
},
|
|
1700
1713
|
"responseFields": {
|
|
1701
1714
|
"type": "object",
|
|
1702
|
-
"description": "The json object with response fields of the call to
|
|
1715
|
+
"description": "The json object with response fields of the call to populate the cache",
|
|
1703
1716
|
"additionalProperties": {
|
|
1704
1717
|
"type": [
|
|
1705
1718
|
"string",
|
|
Binary file
|
package/report/adapterInfo.json
CHANGED