Skip to content

Commit e67191f

Browse files
authored
Update addCloud endpoint doc with GCE (#133)
1 parent 6cb4f0e commit e67191f

File tree

1 file changed

+21
-26
lines changed

1 file changed

+21
-26
lines changed

endpoints/2-cloud-endpoints.md

Lines changed: 21 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,8 @@ Note that cloud credentials are validated only during async process.
3737
"defaultNetwork": "{{os-defaultNetwork}}",
3838
"credentials": {
3939
"user": "{{os-user}}",
40-
"projectId": null,
4140
"secret": "{{os-secret}}",
42-
"domain": "{{os-domain}}",
43-
"subscriptionId": null
41+
"domain": "{{os-domain}}"
4442
},
4543
"blacklist": null
4644
}
@@ -72,10 +70,8 @@ Note that cloud credentials are validated only during async process.
7270
"defaultNetwork": null,
7371
"credentials": {
7472
"user": "{{aws-user}}",
75-
"projectId": null,
7673
"secret": "{{aws-secret}}",
77-
"domain": null,
78-
"subscriptionId": null
74+
"domain": null
7975
},
8076
"blacklist": null
8177
}
@@ -107,7 +103,6 @@ Note that cloud credentials are validated only during async process.
107103
"defaultNetwork": null,
108104
"credentials": {
109105
"user": "{{azure-user}}",
110-
"projectId": null,
111106
"secret": "{{azure-secret}}",
112107
"domain": "{{azure-domain}}",
113108
"subscriptionId": "{{azure-subscription_id}}"
@@ -144,8 +139,7 @@ Note that cloud credentials are validated only during async process.
144139
"user": "{{gce-user}}",
145140
"projectId": "{{gce-project-id}}",
146141
"secret": "{{gce-secret}}",
147-
"domain": null,
148-
"subscriptionId": null
142+
"domain": null
149143
},
150144
"region": null,
151145
"blacklist": null
@@ -156,54 +150,55 @@ Note that cloud credentials are validated only during async process.
156150
**Reply:** Error code, 0 if no Errors
157151

158152
- `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.
160154
Must be 3-253 characters and contain only lowercase letters, numbers, and hyphens.
161155

162156
- `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"`.
164158

165159
- `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).
167161

168162
- `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.
170164

171165
- `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.
173167

174168
- `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:
176170

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.
181175

182176
- `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+
184179
- `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:
186181

187182
- `prefix` (string or `null`): For OpenStack, use `"project"`. Set to `null` for AWS, Azure and GCE.
188183
- `value` (string or `null`): Project name for OpenStack. Set to `null` for AWS, Azure and GCE.
189184

190185
- `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.
192187

193188
- `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.
195190

196191
- `credentials` (object):
197-
Contains authentication details for accessing the cloud. The fields are:
192+
Contains authentication details for accessing the cloud. The fields are:
198193

199194
- `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.
201196
- `secret` (string): The cloud password or secret access key.
202197
- `domain` (string or `null`): The domain for the cloud account, required by OS and Azure. Set to `null` for AWS and GCE.
203198
- `subscriptionId` (string or `null`): The subscription id for the cloud account, required by Azure. Set to `null` for OS, AWS and GCE.
204199

205200
- `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.
207202

208203
#### 2.2- GetAllClouds endpoint:
209204

0 commit comments

Comments
 (0)