You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: endpoints/2-cloud-endpoints.md
+21-26Lines changed: 21 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,10 +37,8 @@ Note that cloud credentials are validated only during async process.
37
37
"defaultNetwork": "{{os-defaultNetwork}}",
38
38
"credentials": {
39
39
"user": "{{os-user}}",
40
-
"projectId": null,
41
40
"secret": "{{os-secret}}",
42
-
"domain": "{{os-domain}}",
43
-
"subscriptionId": null
41
+
"domain": "{{os-domain}}"
44
42
},
45
43
"blacklist": null
46
44
}
@@ -72,10 +70,8 @@ Note that cloud credentials are validated only during async process.
72
70
"defaultNetwork": null,
73
71
"credentials": {
74
72
"user": "{{aws-user}}",
75
-
"projectId": null,
76
73
"secret": "{{aws-secret}}",
77
-
"domain": null,
78
-
"subscriptionId": null
74
+
"domain": null
79
75
},
80
76
"blacklist": null
81
77
}
@@ -107,7 +103,6 @@ Note that cloud credentials are validated only during async process.
107
103
"defaultNetwork": null,
108
104
"credentials": {
109
105
"user": "{{azure-user}}",
110
-
"projectId": null,
111
106
"secret": "{{azure-secret}}",
112
107
"domain": "{{azure-domain}}",
113
108
"subscriptionId": "{{azure-subscription_id}}"
@@ -144,8 +139,7 @@ Note that cloud credentials are validated only during async process.
144
139
"user": "{{gce-user}}",
145
140
"projectId": "{{gce-project-id}}",
146
141
"secret": "{{gce-secret}}",
147
-
"domain": null,
148
-
"subscriptionId": null
142
+
"domain": null
149
143
},
150
144
"region": null,
151
145
"blacklist": null
@@ -156,54 +150,55 @@ Note that cloud credentials are validated only during async process.
156
150
**Reply:** Error code, 0 if no Errors
157
151
158
152
-`cloudId` (string):
159
-
This is a unique identifier for the cloud infrastructure. Choose a unique descriptive name for easy identification, as it will be referenced by SAL.
153
+
This is a unique identifier for the cloud infrastructure. Choose a unique descriptive name for easy identification, as it will be referenced by SAL.
160
154
Must be 3-253 characters and contain only lowercase letters, numbers, and hyphens.
161
155
162
156
-`cloudProviderName` (string):
163
-
The name of the cloud provider. For OpenStack, use `"openstack"`, for AWS, use `"aws-ec2"`, for Azure use `"azure"`, for GCE use `"google-compute-engine"`.
157
+
The name of the cloud provider. For OpenStack, use `"openstack"`, for AWS, use `"aws-ec2"`, for Azure use `"azure"`, for GCE use `"google-compute-engine"`.
164
158
165
159
-`cloudType` (string):
166
-
Specifies whether the cloud infrastructure is `"PRIVATE"` (e.g., for OpenStack) or `"PUBLIC"` (e.g., for AWS).
160
+
Specifies whether the cloud infrastructure is `"PRIVATE"` (e.g., for OpenStack) or `"PUBLIC"` (e.g., for AWS).
167
161
168
162
-`subnet` (string or `null`):
169
-
This defines the specific subnet for your cloud infrastructure. If not needed, set this field to null.
163
+
This defines the specific subnet for your cloud infrastructure. If not needed, set this field to null.
170
164
171
165
-`securityGroup` (string):
172
-
The security group associated with this cloud configuration. Use the security group name applicable to your infrastructure’s security rules.
166
+
The security group associated with this cloud configuration. Use the security group name applicable to your infrastructure’s security rules. Set to `null` for Azure and GCE. Optional for Openstack and AWS.
173
167
174
168
-`sshCredentials` (object):
175
-
Contains SSH access information for the cloud. For Open Stack and AWS should be defined on cloud provider side, while for Azure is automatically created as specified here. The required fields are:
169
+
Contains SSH access information for the cloud. For Open Stack and AWS should be defined on cloud provider side, while for Azure is automatically created as specified here. The required fields are:
176
170
177
-
- `username` (string): The SSH username.
178
-
- `keyPairName` (string): The name of the key pair used for SSH access. Optional for Openstack and AWS.
179
-
- `publicKey` (string or `null`): The single line public key in RSA format. If not required, use `null`. Optional for Azure and GCE.
180
-
- `privateKey` (string or `null`): The private key in RSA format, with line breaks represented by `\n` for JSON compatibility. If not required, use `null`. For Azure, set it to the VM ssh password. Optional for AWS and GCE.
171
+
-`username` (string): The SSH username.
172
+
-`keyPairName` (string): The name of the key pair used for SSH access. Set to `null` for Azure and GCE. Optional for Openstack and AWS.
173
+
-`publicKey` (string or `null`): The single line public key in RSA format. Optional for Azure and GCE.
174
+
-`privateKey` (string or `null`): The private key in RSA format, with line breaks represented by `\n` for JSON compatibility. For Azure, set it to the VM ssh password. Optional for AWS and GCE.
181
175
182
176
-`endpoint` (string or `null`):
183
-
The authentication endpoint for the cloud provider. For OpenStack, use your specific authentication URL. Set to `null` for AWS, Azure and GCE.
177
+
The authentication endpoint for the cloud provider. For OpenStack, use your specific authentication URL. Set to `null` for AWS, Azure and GCE.
178
+
184
179
-`scope` (object):
185
-
Defines the scope of the cloud access, typically is used for OpenStack. Set to `null` for AWS, Azure and GCE. It contains:
180
+
Defines the scope of the cloud access, typically is used for OpenStack. Set to `null` for AWS, Azure and GCE. This property contains:
186
181
187
182
-`prefix` (string or `null`): For OpenStack, use `"project"`. Set to `null` for AWS, Azure and GCE.
188
183
-`value` (string or `null`): Project name for OpenStack. Set to `null` for AWS, Azure and GCE.
189
184
190
185
-`identityVersion` (string or `null`):
191
-
Specifies the version of the identity API. This is required for OpenStack. Set to `null` for AWS, Azure and GCE.
186
+
Specifies the version of the identity API. This is required for OpenStack. Set to `null` for AWS, Azure and GCE.
192
187
193
188
-`defaultNetwork` (string or `null`):
194
-
Specifies the default network identifier, used primarily by OpenStack. Set to `null` for AWS, Azure and GCE.
189
+
Specifies the default network identifier, used primarily by OpenStack. Set to `null` for AWS, Azure and GCE.
195
190
196
191
-`credentials` (object):
197
-
Contains authentication details for accessing the cloud. The fields are:
192
+
Contains authentication details for accessing the cloud. The fields are:
198
193
199
194
-`user` (string): The cloud username or access key.
200
-
-`projectId` (string): The GCE project id. Set to `null` for OS, AWS and Azure.
195
+
-`projectId` (string): The GCE project id.
201
196
-`secret` (string): The cloud password or secret access key.
202
197
-`domain` (string or `null`): The domain for the cloud account, required by OS and Azure. Set to `null` for AWS and GCE.
203
198
-`subscriptionId` (string or `null`): The subscription id for the cloud account, required by Azure. Set to `null` for OS, AWS and GCE.
204
199
205
200
-`blacklist` (string or `null`):
206
-
Allows you to specify any blacklisted regions (e.g. locations). Use `null` if not applicable.
201
+
Allows you to specify any blacklisted regions (e.g. locations). Use `null` if not applicable.
0 commit comments