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
+57-14Lines changed: 57 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,8 +37,10 @@ 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,
40
41
"secret": "{{os-secret}}",
41
-
"domain": "{{os-domain}}"
42
+
"domain": "{{os-domain}}",
43
+
"subscriptionId": null
42
44
},
43
45
"blacklist": null
44
46
}
@@ -70,8 +72,10 @@ Note that cloud credentials are validated only during async process.
70
72
"defaultNetwork": null,
71
73
"credentials": {
72
74
"user": "{{aws-user}}",
75
+
"projectId": null,
73
76
"secret": "{{aws-secret}}",
74
-
"domain": null
77
+
"domain": null,
78
+
"subscriptionId": null
75
79
},
76
80
"blacklist": null
77
81
}
@@ -103,6 +107,7 @@ Note that cloud credentials are validated only during async process.
103
107
"defaultNetwork": null,
104
108
"credentials": {
105
109
"user": "{{azure-user}}",
110
+
"projectId": null,
106
111
"secret": "{{azure-secret}}",
107
112
"domain": "{{azure-domain}}",
108
113
"subscriptionId": "{{azure-subscription_id}}"
@@ -112,13 +117,50 @@ Note that cloud credentials are validated only during async process.
112
117
]
113
118
```
114
119
120
+
* For GCE cloud:
121
+
122
+
```json
123
+
[
124
+
{
125
+
"cloudId": "{{cloud_name}}",
126
+
"cloudProviderName": "google-compute-engine",
127
+
"cloudType": "PUBLIC",
128
+
"subnet": null,
129
+
"securityGroup": null,
130
+
"sshCredentials": {
131
+
"username": "ubuntu",
132
+
"keyPairName": null,
133
+
"publicKey": "{{gce-publickey}}",
134
+
"privateKey": "{{gce-privatekey}}"
135
+
},
136
+
"endpoint": null,
137
+
"scope": {
138
+
"prefix": null,
139
+
"value": null
140
+
},
141
+
"identityVersion": null,
142
+
"defaultNetwork": null,
143
+
"credentials": {
144
+
"user": "{{gce-user}}",
145
+
"projectId": "{{gce-project-id}}",
146
+
"secret": "{{gce-secret}}",
147
+
"domain": null,
148
+
"subscriptionId": null
149
+
},
150
+
"region": null,
151
+
"blacklist": null
152
+
}
153
+
]
154
+
```
155
+
115
156
**Reply:** Error code, 0 if no Errors
116
157
117
158
-`cloudId` (string):
118
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.
119
160
Must be 3-253 characters and contain only lowercase letters, numbers, and hyphens.
161
+
120
162
-`cloudProviderName` (string):
121
-
The name of the cloud provider. For OpenStack, use `"openstack"`, and for AWS, use `"aws-ec2"`, for Azure `"azure"`.
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"`.
122
164
123
165
-`cloudType` (string):
124
166
Specifies whether the cloud infrastructure is `"PRIVATE"` (e.g., for OpenStack) or `"PUBLIC"` (e.g., for AWS).
@@ -133,31 +175,32 @@ The security group associated with this cloud configuration. Use the security gr
133
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:
134
176
135
177
- `username` (string): The SSH username.
136
-
- `keyPairName` (string): The name of the key pair used for SSH access.
137
-
- `publicKey` (string or `null`): The public key in RSA format. If not required, use `null`.
138
-
- `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.
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.
139
181
140
182
-`endpoint` (string or `null`):
141
-
The authentication endpoint for the cloud provider. For OpenStack, use your specific authentication URL. AWS and Azure does not require this field, so it can be `null`.
183
+
The authentication endpoint for the cloud provider. For OpenStack, use your specific authentication URL. Set to `null` for AWS, Azure and GCE.
142
184
-`scope` (object):
143
-
Defines the scope of the cloud access, typically is used for OpenStack. Contains:
185
+
Defines the scope of the cloud access, typically is used for OpenStack. Set to `null` for AWS, Azure and GCE. It contains:
144
186
145
-
-`prefix` (string or `null`): For OpenStack, use `"project"`. Set to `null` for AWS.
146
-
-`value` (string or `null`): Project name for OpenStack. For AWS, this should be `null`.
187
+
-`prefix` (string or `null`): For OpenStack, use `"project"`. Set to `null` for AWS, Azure and GCE.
188
+
-`value` (string or `null`): Project name for OpenStack. Set to `null` for AWS, Azure and GCE.
147
189
148
190
-`identityVersion` (string or `null`):
149
-
Specifies the version of the identity API. This is required for OpenStack but should be `null` for AWS.
191
+
Specifies the version of the identity API. This is required for OpenStack. Set to `null` for AWS, Azure and GCE.
150
192
151
193
-`defaultNetwork` (string or `null`):
152
-
Specifies the default network identifier, used primarily by OpenStack. Set this to `null` for AWS.
194
+
Specifies the default network identifier, used primarily by OpenStack. Set to `null` for AWS, Azure and GCE.
153
195
154
196
-`credentials` (object):
155
197
Contains authentication details for accessing the cloud. The fields are:
156
198
157
199
-`user` (string): The cloud username or access key.
200
+
-`projectId` (string): The GCE project id. Set to `null` for OS, AWS and Azure.
158
201
-`secret` (string): The cloud password or secret access key.
159
-
-`domain` (string or `null`): The domain for the cloud account, required by OpenStack. For AWS, set this to `null`.
160
-
-`subscriptionId` (string or `null`): The subscription id for the cloud account, required by Azure. For AWS and OpenStack, set this to `null`.
202
+
-`domain` (string or `null`): The domain for the cloud account, required by OS and Azure. Set to `null` for AWS and GCE.
203
+
-`subscriptionId` (string or `null`): The subscription id for the cloud account, required by Azure. Set to `null` for OS, AWS and GCE.
161
204
162
205
-`blacklist` (string or `null`):
163
206
Allows you to specify any blacklisted regions (e.g. locations). Use `null` if not applicable.
0 commit comments