@itentialopensource/adapter-openstack_neutron 3.0.3 → 3.1.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.
Files changed (42) hide show
  1. package/AUTH.md +9 -9
  2. package/CALLS.md +364 -328
  3. package/CHANGELOG.md +8 -0
  4. package/CONTRIBUTING.md +1 -160
  5. package/ENHANCE.md +2 -2
  6. package/README.md +32 -23
  7. package/adapter.js +174 -373
  8. package/adapterBase.js +517 -875
  9. package/changelogs/CHANGELOG.md +58 -0
  10. package/metadata.json +56 -0
  11. package/package.json +24 -26
  12. package/pronghorn.json +474 -142
  13. package/propertiesSchema.json +431 -34
  14. package/refs?service=git-upload-pack +0 -0
  15. package/report/adapter-openapi.json +14594 -0
  16. package/report/adapter-openapi.yaml +12289 -0
  17. package/report/adapterInfo.json +8 -8
  18. package/report/updateReport1691507382282.json +120 -0
  19. package/report/updateReport1692202417483.json +120 -0
  20. package/report/updateReport1694460523394.json +120 -0
  21. package/report/updateReport1698420447048.json +120 -0
  22. package/sampleProperties.json +58 -3
  23. package/test/integration/adapterTestBasicGet.js +2 -4
  24. package/test/integration/adapterTestConnectivity.js +91 -42
  25. package/test/integration/adapterTestIntegration.js +130 -2
  26. package/test/unit/adapterBaseTestUnit.js +389 -317
  27. package/test/unit/adapterTestUnit.js +303 -114
  28. package/utils/adapterInfo.js +1 -1
  29. package/utils/addAuth.js +1 -1
  30. package/utils/artifactize.js +1 -1
  31. package/utils/checkMigrate.js +1 -1
  32. package/utils/entitiesToDB.js +2 -2
  33. package/utils/findPath.js +1 -1
  34. package/utils/methodDocumentor.js +71 -23
  35. package/utils/modify.js +13 -15
  36. package/utils/packModificationScript.js +1 -1
  37. package/utils/taskMover.js +309 -0
  38. package/utils/tbScript.js +89 -34
  39. package/utils/tbUtils.js +41 -21
  40. package/utils/testRunner.js +1 -1
  41. package/utils/troubleshootingAdapter.js +9 -6
  42. package/workflows/README.md +0 -3
package/AUTH.md CHANGED
@@ -1,12 +1,12 @@
1
- ## Authenticating Openstack_neutron Adapter
1
+ ## Authenticating OpenStack Neutron Adapter
2
2
 
3
- This document will go through the steps for authenticating the Openstack_neutron adapter with Basic 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://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>.
3
+ This document will go through the steps for authenticating the OpenStack Neutron adapter with Two Step Token from Keystone. 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
- ### Request Token Authentication
6
- If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
5
+ ### Two Step Token
6
+ The OpenStack Neutron adapter requires Authentication Token from Keystone. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
7
7
 
8
8
  STEPS
9
- 1. Ensure you have access to a Openstack_neutron server and that it is running
9
+ 1. Ensure you have access to a OpenStack Neutron server and that it is running
10
10
  2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
11
11
  3. Use the properties below for the ```properties.authentication``` field
12
12
  ```json
@@ -21,9 +21,6 @@ STEPS
21
21
  "auth_field": "header.headers.X-Auth-Token",
22
22
  "auth_field_format": "{token}",
23
23
  "auth_logging": false,
24
- "client_id": "",
25
- "client_secret": "",
26
- "grant_type": "",
27
24
  "os_user_domain_name": "Default",
28
25
  "os_project_name": "admin",
29
26
  "os_project_domain_name": "Default",
@@ -33,9 +30,11 @@ STEPS
33
30
  "port": 5000
34
31
  }
35
32
  }
36
-
37
33
  ```
38
34
  4. `sso` can be configured with keystone auth data in the authentication section of the adapter config as shown above. Optionally, it can also be configured in .system/action.json.
35
+
36
+ you can leave all of the other properties in the authentication section, they will not be used when the auth_method is request_token.
37
+
39
38
  5. Restart the adapter. If your properties were set correctly, the adapter should go online.
40
39
 
41
40
  ### Troubleshooting
@@ -46,4 +45,5 @@ STEPS
46
45
  - The FULL REQUEST log to make sure the proper headers are being sent with the request.
47
46
  - The FULL BODY log to make sure the payload is accurate.
48
47
  - The CALL RETURN log to see what the other system is telling us.
48
+ - Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
49
49
  - Remember when you are done to turn auth_logging off as you do not want to log credentials.