@itentialopensource/adapter-aws_cloudformation 0.2.10 → 0.3.0
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 +49 -10
- package/BROKER.md +31 -19
- package/CHANGELOG.md +8 -0
- package/PROPERTIES.md +5 -0
- package/README.md +60 -63
- package/SUMMARY.md +1 -1
- package/SYSTEMINFO.md +25 -0
- package/TAB1.md +11 -1
- package/TAB2.md +119 -1594
- package/metadata.json +21 -4
- package/package.json +6 -8
- package/propertiesSchema.json +5 -0
- package/refs?service=git-upload-pack +0 -0
- package/report/adapterInfo.json +4 -4
- package/report/updateReport1717535381614.json +120 -0
- package/sampleProperties.json +43 -25
- package/test/integration/adapterTestIntegration.js +1 -0
- package/test/unit/adapterTestUnit.js +2 -4
package/AUTH.md
CHANGED
|
@@ -1,23 +1,23 @@
|
|
|
1
1
|
## Authenticating AWS CloudFormation 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 CloudFormation 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 AWS CloudFormation
|
|
6
|
+
The AWS CloudFormation 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.
|
|
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
|
-
The AWS CloudFormation
|
|
17
|
+
The AWS CloudFormation adapter requires AWS Signature 4 Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
|
|
18
18
|
|
|
19
19
|
STEPS
|
|
20
|
-
1. Ensure you have access to AWS CloudFormation
|
|
20
|
+
1. Ensure you have access to a AWS CloudFormation server and that it is running
|
|
21
21
|
2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
|
|
22
22
|
3. Use the properties below for the ```properties.authentication``` field
|
|
23
23
|
```json
|
|
@@ -26,16 +26,55 @@ STEPS
|
|
|
26
26
|
"aws_access_key": "aws_access_key",
|
|
27
27
|
"aws_secret_key": "aws_secret_key",
|
|
28
28
|
"aws_session_token": "aws_session_token"
|
|
29
|
-
}
|
|
29
|
+
}
|
|
30
30
|
```
|
|
31
31
|
you can leave all of the other properties in the authentication section, they will not be used for AWS CloudFormation authentication.
|
|
32
32
|
4. Restart the adapter. If your properties were set correctly, the adapter should go online.
|
|
33
33
|
|
|
34
34
|
### AWS Security Token Service
|
|
35
|
-
The AWS CloudFormation
|
|
35
|
+
The AWS CloudFormation adapter also supports AWS Security Token Service (STS) Authentication. 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. The data provided below will enable the adapter to switch to `my_role` in order to make the call to CloudFormation:
|
|
36
|
+
|
|
37
|
+
```json
|
|
38
|
+
{
|
|
39
|
+
"RoleArn": "arn:aws:iam::1234567:role/my_role",
|
|
40
|
+
"RoleSessionName": "mySession"
|
|
41
|
+
}
|
|
42
|
+
```
|
|
36
43
|
|
|
37
44
|
### AWS IAM Role
|
|
38
|
-
The AWS CloudFormation
|
|
45
|
+
The AWS CloudFormation 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.
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
"authentication": {
|
|
49
|
+
"auth_method": "aws_authentication",
|
|
50
|
+
"aws_iam_role": "role_arn"
|
|
51
|
+
}
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### AMAZON STEPS FOR IAM ROLE
|
|
55
|
+
Increase number of hops if running IAP inside of docker on EC2 instance
|
|
56
|
+
```bash
|
|
57
|
+
aws sso login --profile aws-bota-1
|
|
58
|
+
<export aws keys for CLI access>
|
|
59
|
+
|
|
60
|
+
AWS ec2 modify-instance-metadata-options --instance-id i-0e150236026b7c45d --http-put-response-hop-limit 3 --http-endpoint enabled --region us-east-1
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Create a new role and attach to it policies:
|
|
64
|
+
- go to your EC2 instance, select it
|
|
65
|
+
- Actions->Security->Modify IAM Role
|
|
66
|
+
- Click 'Create New IAM Role'
|
|
67
|
+
- Create a role:
|
|
68
|
+
```text
|
|
69
|
+
Trusted entity type: AWS service
|
|
70
|
+
Use Case: EC2
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Add desired policies to the role.
|
|
74
|
+
|
|
75
|
+
Save the role
|
|
76
|
+
|
|
77
|
+
Go back to your EC2 instance and Actions->Security->Modify IAM Role, associate newly created role with your EC2 instance
|
|
39
78
|
|
|
40
79
|
### Troubleshooting
|
|
41
80
|
- Make sure you copied over the correct access key, secret key and session token.
|
|
@@ -49,5 +88,5 @@ The AWS CloudFormation Adapter also supports AWS IAM Role Authentication. For us
|
|
|
49
88
|
- Remember when you are done to turn auth_logging off as you do not want to log credentials.
|
|
50
89
|
- For IAM, you can run this on the IAP server to verify you are getting to the "internal" AWS Server
|
|
51
90
|
```bash
|
|
52
|
-
TOKEN=`curl -v -X PUT "http://169.254.169.254/latest/api/token" -H "X-aws-
|
|
91
|
+
TOKEN=`curl -v -X PUT "http://169.254.169.254/latest/api/token" -H "X-aws-ec2-metadata-token-ttl-seconds: 21600"` && curl -v -H "X-aws-ec2-metadata-token: $TOKEN" -v http://169.254.169.254/latest/meta-data/iam/security-credentials/<rolename>
|
|
53
92
|
```
|
package/BROKER.md
CHANGED
|
@@ -22,18 +22,25 @@ Below is an example of how you may set up the properties for this call.
|
|
|
22
22
|
{
|
|
23
23
|
"path": "/{org}/get/devices",
|
|
24
24
|
"method": "GET",
|
|
25
|
+
"pagination": {
|
|
26
|
+
"offsetVar": "",
|
|
27
|
+
"limitVar": "",
|
|
28
|
+
"incrementBy": "limit",
|
|
29
|
+
"requestLocation": "query"
|
|
30
|
+
},
|
|
25
31
|
"query": {},
|
|
26
32
|
"body": {},
|
|
27
33
|
"headers": {},
|
|
28
34
|
"handleFailure": "ignore",
|
|
35
|
+
"responseDataKey": "",
|
|
29
36
|
"requestFields": {
|
|
30
37
|
"org": "555"
|
|
31
38
|
},
|
|
32
39
|
"responseFields": {
|
|
33
|
-
"name": "
|
|
34
|
-
"ostype": "
|
|
40
|
+
"name": "{hostField}",
|
|
41
|
+
"ostype": "{osField}",
|
|
35
42
|
"ostypePrefix": "system-",
|
|
36
|
-
"ipaddress": "attributes.ipaddr",
|
|
43
|
+
"ipaddress": "{attributes.ipaddr}",
|
|
37
44
|
"port": "443"
|
|
38
45
|
}
|
|
39
46
|
},
|
|
@@ -44,16 +51,17 @@ Below is an example of how you may set up the properties for this call.
|
|
|
44
51
|
"body": {},
|
|
45
52
|
"headers": {},
|
|
46
53
|
"handleFailure": "ignore",
|
|
54
|
+
"responseDataKey": "",
|
|
47
55
|
"requestFields": {
|
|
48
56
|
"org": "777"
|
|
49
57
|
},
|
|
50
58
|
"responseFields": {
|
|
51
|
-
"name": "
|
|
52
|
-
"ostype": "
|
|
59
|
+
"name": "{hostField}",
|
|
60
|
+
"ostype": "{osField}",
|
|
53
61
|
"ostypePrefix": "system-",
|
|
54
|
-
"ipaddress": "attributes.ipaddr",
|
|
62
|
+
"ipaddress": "{attributes.ipaddr}",
|
|
55
63
|
"port": "443",
|
|
56
|
-
"myorg": "
|
|
64
|
+
"myorg": "{orgField}"
|
|
57
65
|
}
|
|
58
66
|
}
|
|
59
67
|
]
|
|
@@ -88,12 +96,13 @@ Below is an example of how you may set up the properties for this call.
|
|
|
88
96
|
"headers": {},
|
|
89
97
|
"handleFailure": "ignore",
|
|
90
98
|
"statusValue": "online",
|
|
99
|
+
"responseDataKey": "",
|
|
91
100
|
"requestFields": {
|
|
92
|
-
"org": "myorg",
|
|
93
|
-
"id": "name"
|
|
101
|
+
"org": "{myorg}",
|
|
102
|
+
"id": "{name}"
|
|
94
103
|
},
|
|
95
104
|
"responseFields": {
|
|
96
|
-
"status": "status"
|
|
105
|
+
"status": "{status}"
|
|
97
106
|
}
|
|
98
107
|
}
|
|
99
108
|
]
|
|
@@ -129,9 +138,10 @@ Below is an example of how you may set up the properties for this call.
|
|
|
129
138
|
"body": {},
|
|
130
139
|
"headers": {},
|
|
131
140
|
"handleFailure": "ignore",
|
|
141
|
+
"responseDataKey": "",
|
|
132
142
|
"requestFields": {
|
|
133
|
-
"org": "myorg",
|
|
134
|
-
"id": "name"
|
|
143
|
+
"org": "{myorg}",
|
|
144
|
+
"id": "{name}"
|
|
135
145
|
}
|
|
136
146
|
"responseFields": {}
|
|
137
147
|
},
|
|
@@ -142,8 +152,9 @@ Below is an example of how you may set up the properties for this call.
|
|
|
142
152
|
"body": {},
|
|
143
153
|
"headers": {},
|
|
144
154
|
"handleFailure": "ignore",
|
|
155
|
+
"responseDataKey": "",
|
|
145
156
|
"requestFields": {
|
|
146
|
-
"org": "myorg"
|
|
157
|
+
"org": "{myorg}"
|
|
147
158
|
}
|
|
148
159
|
"responseFields": {}
|
|
149
160
|
}
|
|
@@ -178,17 +189,18 @@ Below is an example of how you may set up the properties for this call.
|
|
|
178
189
|
"body": {},
|
|
179
190
|
"headers": {},
|
|
180
191
|
"handleFailure": "ignore",
|
|
192
|
+
"responseDataKey": "",
|
|
181
193
|
"requestFields": {
|
|
182
|
-
"org": "myorg",
|
|
183
|
-
"id": "name"
|
|
194
|
+
"org": "{myorg}",
|
|
195
|
+
"id": "{name}"
|
|
184
196
|
},
|
|
185
197
|
"responseFields": {
|
|
186
|
-
"name": "
|
|
187
|
-
"ostype": "
|
|
198
|
+
"name": "{hostField}",
|
|
199
|
+
"ostype": "{osField}",
|
|
188
200
|
"ostypePrefix": "system-",
|
|
189
|
-
"ipaddress": "attributes.ipaddr",
|
|
201
|
+
"ipaddress": "{attributes.ipaddr}",
|
|
190
202
|
"port": "443",
|
|
191
|
-
"myorg": "
|
|
203
|
+
"myorg": "{orgField}"
|
|
192
204
|
}
|
|
193
205
|
}
|
|
194
206
|
]
|
package/CHANGELOG.md
CHANGED
package/PROPERTIES.md
CHANGED
|
@@ -97,6 +97,7 @@ This section defines **all** the properties that are available for the adapter,
|
|
|
97
97
|
}
|
|
98
98
|
},
|
|
99
99
|
"devicebroker": {
|
|
100
|
+
"enabled": false,
|
|
100
101
|
"getDevice": [
|
|
101
102
|
{
|
|
102
103
|
"path": "/call/to/get/device/details",
|
|
@@ -580,6 +581,10 @@ The device broker section defines the properties used integrate AwsCloudFormatio
|
|
|
580
581
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
|
|
581
582
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
|
|
582
583
|
</tr>
|
|
584
|
+
<tr>
|
|
585
|
+
<td style="padding:15px">enabled</td>
|
|
586
|
+
<td style="padding:15px">Whether or not the device broker calls have been mapped.</td>
|
|
587
|
+
</tr>
|
|
583
588
|
<tr>
|
|
584
589
|
<td style="padding:15px">getDevice</td>
|
|
585
590
|
<td style="padding:15px">The array of calls used to get device details for the broker</td>
|
package/README.md
CHANGED
|
@@ -4,29 +4,49 @@
|
|
|
4
4
|
|
|
5
5
|
Some of the page links in this document and links to other GitLab files do not work in Confluence however, the information is available in other sections of the Confluence material.
|
|
6
6
|
|
|
7
|
-
- [
|
|
8
|
-
- [Versioning](#versioning)
|
|
9
|
-
- [Supported IAP Versions](#supported-iap-versions)
|
|
10
|
-
- [Getting Started](#getting-started)
|
|
11
|
-
- [Helpful Background Information](#helpful-background-information)
|
|
12
|
-
- [Prerequisites](#prerequisites)
|
|
13
|
-
- [How to Install](#how-to-install)
|
|
14
|
-
- [Testing](#testing)
|
|
15
|
-
- [Configuration](./PROPERTIES.md)
|
|
16
|
-
- [Using this Adapter](./CALLS.md)
|
|
7
|
+
- [Specific to this Adapter](#specific-to-this-adapter)
|
|
17
8
|
- [Authentication](./AUTH.md)
|
|
18
|
-
- [
|
|
19
|
-
- [
|
|
20
|
-
- [
|
|
21
|
-
|
|
22
|
-
- [
|
|
23
|
-
- [
|
|
24
|
-
- [
|
|
25
|
-
- [
|
|
9
|
+
- [Sample Properties](./sampleProperties.json)
|
|
10
|
+
- [Available Calls](./CALLS.md)
|
|
11
|
+
- [Swagger](./report/adapter-openapi.json)
|
|
12
|
+
- [Generic Adapter Information](#generic-adapter-information)
|
|
13
|
+
- [Overview](./SUMMARY.md)
|
|
14
|
+
- [Versioning](#versioning)
|
|
15
|
+
- [Supported IAP Versions](#supported-iap-versions)
|
|
16
|
+
- [Getting Started](#getting-started)
|
|
17
|
+
- [Helpful Background Information](#helpful-background-information)
|
|
18
|
+
- [Prerequisites](#prerequisites)
|
|
19
|
+
- [How to Install](#how-to-install)
|
|
20
|
+
- [Testing](#testing)
|
|
21
|
+
- [Configuration](./PROPERTIES.md)
|
|
22
|
+
- [Additional Information](#additional-information)
|
|
23
|
+
- [Enhancements](./ENHANCE.md)
|
|
24
|
+
- [Contributing](./CONTRIBUTING.md)
|
|
25
|
+
- [Helpful Links](#helpful-links)
|
|
26
|
+
- [Node Scripts](#node-scripts)
|
|
27
|
+
- [Troubleshoot](./TROUBLESHOOT.md)
|
|
28
|
+
- [License and Maintainers](#license-and-maintainers)
|
|
29
|
+
- [Product License](#product-license)
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
## Specific to this Adapter
|
|
26
33
|
|
|
27
|
-
|
|
34
|
+
### [Authentication](./AUTH.md)
|
|
35
|
+
|
|
36
|
+
### [Sample Properties](./sampleProperties.json)
|
|
37
|
+
|
|
38
|
+
<a href="./sampleProperties.json" target="_blank">Sample Properties</a> can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
|
|
39
|
+
|
|
40
|
+
### [Available Calls](./CALLS.md)
|
|
41
|
+
|
|
42
|
+
### [Swagger](./report/adapter-openapi.json)
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
## Generic Adapter Information
|
|
28
46
|
|
|
29
|
-
|
|
47
|
+
### [Overview](./SUMMARY.md)
|
|
48
|
+
|
|
49
|
+
### Versioning
|
|
30
50
|
|
|
31
51
|
Itential Product and opensource adapters utilize SemVer for versioning. The current version of the adapter can be found in the `package.json` file or viewed in the IAP GUI on the System page. All Itential opensource adapters can be found in the <a href="https://gitlab.com/itentialopensource/adapters" target="_blank">Itential OpenSource Repository</a>.
|
|
32
52
|
|
|
@@ -34,7 +54,7 @@ Any release prior to 1.0.0 is a pre-release. Initial builds of adapters are gene
|
|
|
34
54
|
|
|
35
55
|
Release notes can be viewed in CHANGELOG.md.
|
|
36
56
|
|
|
37
|
-
|
|
57
|
+
### Supported IAP Versions
|
|
38
58
|
|
|
39
59
|
Itential Product adapters are built for particular versions of IAP and packaged with the versions they work with.
|
|
40
60
|
|
|
@@ -42,11 +62,11 @@ Itential opensource adapter as well as custom adapters built with the Itential A
|
|
|
42
62
|
|
|
43
63
|
Many of the scripts that come with all adapters built using the Itential Adapter Builder do have some dependencies on IAP or the IAP database schema and so it is possible these scripts could stop working in different versions of IAP. If you notify Itential of any issues, the Adapter Team will attempt to fix the scripts for newer releases of IAP.
|
|
44
64
|
|
|
45
|
-
|
|
65
|
+
### Getting Started
|
|
46
66
|
|
|
47
67
|
These instructions will help you get a copy of the project on your local machine for development and testing. Reading this section is also helpful for deployments as it provides you with pertinent information on prerequisites and properties.
|
|
48
68
|
|
|
49
|
-
|
|
69
|
+
#### Helpful Background Information
|
|
50
70
|
|
|
51
71
|
There is <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter documentation available on the Itential Documentation Site</a>. This documentation includes information and examples that are helpful for:
|
|
52
72
|
|
|
@@ -67,7 +87,7 @@ Troubleshooting an Adapter
|
|
|
67
87
|
Others will be added over time.
|
|
68
88
|
Want to build a new adapter? Use the <a href="https://adapters.itential.io" target="_blank">Itential Adapter Builder</a>
|
|
69
89
|
|
|
70
|
-
|
|
90
|
+
#### Prerequisites
|
|
71
91
|
|
|
72
92
|
The following is a list of required packages for installation on the system the adapter will run on:
|
|
73
93
|
|
|
@@ -154,7 +174,7 @@ eslint-plugin-json
|
|
|
154
174
|
testdouble
|
|
155
175
|
```
|
|
156
176
|
|
|
157
|
-
|
|
177
|
+
#### How to Install
|
|
158
178
|
|
|
159
179
|
1. Set up the name space location in your IAP node_modules.
|
|
160
180
|
|
|
@@ -167,8 +187,8 @@ if the @itentialopensource directory does not exist, create it:
|
|
|
167
187
|
2. Clone/unzip/tar the adapter into your IAP environment.
|
|
168
188
|
|
|
169
189
|
```bash
|
|
170
|
-
cd
|
|
171
|
-
git clone git@gitlab.com
|
|
190
|
+
cd @itentialopensource
|
|
191
|
+
git clone git@gitlab.com:@itentialopensource/adapters/adapter-aws_cloudformation
|
|
172
192
|
or
|
|
173
193
|
unzip adapter-aws_cloudformation.zip
|
|
174
194
|
or
|
|
@@ -196,30 +216,11 @@ systemctl restart pronghorn
|
|
|
196
216
|
|
|
197
217
|
7. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
|
|
198
218
|
|
|
199
|
-
|
|
200
|
-
For an easier install of the adapter use npm run adapter:install, it will install the adapter in IAP. Please note that it can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If using this, you can replace step 3-5 above with these:
|
|
201
|
-
|
|
202
|
-
3. Install adapter dependencies and check the adapter.
|
|
203
|
-
|
|
204
|
-
```bash
|
|
205
|
-
cd adapter-aws_cloudformation
|
|
206
|
-
npm run adapter:install
|
|
207
|
-
```
|
|
208
|
-
|
|
209
|
-
4. Restart IAP
|
|
210
|
-
|
|
211
|
-
```bash
|
|
212
|
-
systemctl restart pronghorn
|
|
213
|
-
```
|
|
214
|
-
|
|
215
|
-
5. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
### Testing
|
|
219
|
+
#### Testing
|
|
219
220
|
|
|
220
221
|
Mocha is generally used to test all Itential Opensource Adapters. There are unit tests as well as integration tests performed. Integration tests can generally be run as standalone using mock data and running the adapter in stub mode, or as integrated. When running integrated, every effort is made to prevent environmental failures, however there is still a possibility.
|
|
221
222
|
|
|
222
|
-
|
|
223
|
+
##### Unit Testing
|
|
223
224
|
|
|
224
225
|
Unit Testing includes testing basic adapter functionality as well as error conditions that are triggered in the adapter prior to any integration. There are two ways to run unit tests. The prefered method is to use the testRunner script; however, both methods are provided here.
|
|
225
226
|
|
|
@@ -232,7 +233,7 @@ npm run test:baseunit
|
|
|
232
233
|
|
|
233
234
|
To add new unit tests, edit the `test/unit/adapterTestUnit.js` file. The tests that are already in this file should provide guidance for adding additional tests.
|
|
234
235
|
|
|
235
|
-
|
|
236
|
+
##### Integration Testing - Standalone
|
|
236
237
|
|
|
237
238
|
Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from AwsCloudFormation. It will then translate the data so that the adapter can return the expected response to the rest of the Itential software. Standalone is the default integration test.
|
|
238
239
|
|
|
@@ -247,7 +248,7 @@ npm run test:integration
|
|
|
247
248
|
|
|
248
249
|
To add new integration tests, edit the `test/integration/adapterTestIntegration.js` file. The tests that are already in this file should provide guidance for adding additional tests.
|
|
249
250
|
|
|
250
|
-
|
|
251
|
+
##### Integration Testing
|
|
251
252
|
|
|
252
253
|
Integration Testing requires connectivity to AwsCloudFormation. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.
|
|
253
254
|
|
|
@@ -263,23 +264,19 @@ Test should also be written to clean up after themselves. However, it is importa
|
|
|
263
264
|
|
|
264
265
|
> **Reminder**: Do not check in code with actual credentials to systems.
|
|
265
266
|
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
## [Using this Adapter](./CALLS.md)
|
|
269
|
-
|
|
270
|
-
### [Authentication](./AUTH.md)
|
|
267
|
+
### [Configuration](./PROPERTIES.md)
|
|
271
268
|
|
|
272
|
-
|
|
269
|
+
### Additional Information
|
|
273
270
|
|
|
274
|
-
|
|
271
|
+
#### [Enhancements](./ENHANCE.md)
|
|
275
272
|
|
|
276
|
-
|
|
273
|
+
#### [Contributing](./CONTRIBUTING.md)
|
|
277
274
|
|
|
278
|
-
|
|
275
|
+
#### Helpful Links
|
|
279
276
|
|
|
280
277
|
<a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a>
|
|
281
278
|
|
|
282
|
-
|
|
279
|
+
#### Node Scripts
|
|
283
280
|
|
|
284
281
|
There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Many of these scripts can have issues with different versions of IAP as they have dependencies on IAP and Mongo. If you have issues with the scripts please report them to the Itential Adapter Team. Each of these scripts are described below.
|
|
285
282
|
|
|
@@ -331,9 +328,9 @@ There are several node scripts that now accompany the adapter. These scripts are
|
|
|
331
328
|
</table>
|
|
332
329
|
<br>
|
|
333
330
|
|
|
334
|
-
|
|
331
|
+
### [Troubleshoot](./TROUBLESHOOT.md)
|
|
335
332
|
|
|
336
|
-
|
|
333
|
+
### License and Maintainers
|
|
337
334
|
|
|
338
335
|
```text
|
|
339
336
|
Itential Product Adapters are maintained by the Itential Product Team.
|
|
@@ -341,6 +338,6 @@ Itential OpenSource Adapters are maintained by the Itential Adapter Team and the
|
|
|
341
338
|
Custom Adapters are maintained by other sources.
|
|
342
339
|
```
|
|
343
340
|
|
|
344
|
-
|
|
341
|
+
### Product License
|
|
345
342
|
|
|
346
343
|
[Apache 2.0](./LICENSE)
|
package/SUMMARY.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
## Overview
|
|
2
2
|
|
|
3
|
-
This adapter is used to integrate the Itential Automation Platform (IAP) with the
|
|
3
|
+
This adapter is used to integrate the Itential Automation Platform (IAP) with the AwsCloudFormation System. The API that was used to build the adapter for AwsCloudFormation is usually available in the report directory of this adapter. The adapter utilizes the AwsCloudFormation API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
|
|
4
4
|
|
|
5
5
|
>**Note**: It is possible that some integrations will be supported through the AwsCloudFormation adapter while other integrations will not. If you need additional API calls, you can use the Update capabilities provided by the Adapter Builder or request Itential to add them if the Adapter is an Itential opensourced adapter.
|
|
6
6
|
|
package/SYSTEMINFO.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# AWS CloudFormation
|
|
2
|
+
|
|
3
|
+
Vendor: Amazon Web Services (AWS)
|
|
4
|
+
Homepage: https://aws.amazon.com/
|
|
5
|
+
|
|
6
|
+
Product: CloudFormation
|
|
7
|
+
Product Page: https://aws.amazon.com/cloudformation/
|
|
8
|
+
|
|
9
|
+
## Introduction
|
|
10
|
+
We classify AWS CloudFormation into the Cloud domain as it provides a cloud provisioning solution using infrastructure as code.
|
|
11
|
+
|
|
12
|
+
"AWS CloudFormation lets you model, provision, and manage AWS and third-party resources by treating infrastructure as code."
|
|
13
|
+
|
|
14
|
+
## Why Integrate
|
|
15
|
+
The AWS CloudFormation adapter from Itential is used to integrate the Itential Automation Platform (IAP) with AWS CloudFormation.
|
|
16
|
+
|
|
17
|
+
With this adapter you have the ability to perform operations such as:
|
|
18
|
+
|
|
19
|
+
- Get Template
|
|
20
|
+
- Validate Template
|
|
21
|
+
- Create Stack
|
|
22
|
+
- Get Create Stack
|
|
23
|
+
|
|
24
|
+
## Additional Product Documentation
|
|
25
|
+
The [API documents for AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/Welcome.html)
|
package/TAB1.md
CHANGED
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# Overview
|
|
2
2
|
|
|
3
|
-
This adapter is used to integrate the Itential Automation Platform (IAP) with the
|
|
3
|
+
This adapter is used to integrate the Itential Automation Platform (IAP) with the AwsCloudFormation System. The API that was used to build the adapter for AwsCloudFormation is usually available in the report directory of this adapter. The adapter utilizes the AwsCloudFormation API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
|
|
4
|
+
|
|
5
|
+
## Details
|
|
6
|
+
The AWS CloudFormation adapter from Itential is used to integrate the Itential Automation Platform (IAP) with AWS CloudFormation.
|
|
7
|
+
|
|
8
|
+
With this adapter you have the ability to perform operations such as:
|
|
9
|
+
|
|
10
|
+
- Get Template
|
|
11
|
+
- Validate Template
|
|
12
|
+
- Create Stack
|
|
13
|
+
- Get Create Stack
|
|
4
14
|
|
|
5
15
|
For further technical details on how to install and use this adapter, please click the Technical Documentation tab.
|