starlingx
/
distcloud
Code Issues Proposed changes

Updating API docs for dcmanager commands 

Aligns the API doc with its current functionality.

 - Splits the examples (requests and responses)
into their own json files.

 - Splits parameters and result fields into a parameters.yaml
file to simplify shared fields between APIs.

 - Several APIs actually return 200 for delete rather than 204

 - Converted 'Patch' to 'Software Update' when referring
to the variety of update types supported.

 - Added missing fields. ex: extra-args for strategies.

 - Updated responses to include new sync status fields.

Change-Id: I6d26765be0a8e98664f904314af15bfdfab9fda2
Story: 2008675
Task: 43752
Signed-off-by: albailey <Al.Bailey@windriver.com>
This commit is contained in:
albailey 2021-10-12 13:48:38 -05:00
parent 646b69a3c2
commit 20774e10e9
41 changed files with 1939 additions and 1112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1913
api-ref/source/api-ref-dcmanager-v1.rst
View File

File diff suppressed because it is too large Load Diff

556
api-ref/source/parameters.yaml Normal file
View File

@ -0,0 +1,556 @@
---
# variables in path
subcloud_group_uri:
description: |
The subcloud group reference, name or id.
in: path
required: true
type: string
subcloud_options_uri:
description: |
The name of the subcloud to which the options apply.
Use `RegionOne` for querying the default.
in: path
required: true
type: string
subcloud_uri:
description: |
The subcloud reference, name or id.
in: path
required: true
type: string
sw_update_strategy_type:
description: |
Filter to query a particular type of update strategy if it exists.
One of: `firmware`, `kube-rootca-update`, `kubernetes`, `patch`, `upgrade`
in: path
required: false
type: string
# variables in body
alarm_restriction_type:
description: |
Whether to allow update if subcloud alarms are present or not.
Valid values are `strict` or `relaxed`.
in: body
required: true
type: string
alarm_summary:
description: |
The list of alarm summaries.
in: body
required: false
type: array
alarm_summary_uuid:
description: |
The unique identifier for this object.
in: body
required: true
type: string
availability_status:
description: |
The availability status of the subcloud.
in: body
required: true
type: string
bmc_password:
description: |
The BMC password of the subcloud. Must be base64 encoded.
in: body
required: false
type: string
bootstrap_address:
description: |
An OAM IP address of the subcloud controller-0.
in: body
required: true
type: string
bootstrap_values:
description: |
The content of a file containing the bootstrap overrides such as subcloud
name, management and OAM subnet.The sysadmin password of the subcloud.
Must be base64 encoded.
in: body
required: true
type: string
cloud_status:
description: |
The overall alarm status of the subcloud.
in: body
required: true
type: string
created_at:
description: |
The time when the object was created.
in: body
required: true
type: string
critical_alarms:
description: |
Number of critical alarms for subcloud (-1 when cloud_status is disabled).
in: body
required: true
type: integer
data_install:
description: |
The installation data for the subcloud.
in: body
required: true
type: string
data_upgrade:
description: |
The upgrade data for the subcloud.
in: body
required: true
type: string
default_instance_action:
description: |
How instances should be handled.
Valid values are `stop-start` or `migrate`.
in: body
required: true
type: string
deploy_config:
description: |
The content of a file containing the resource definitions describing
the desired subcloud configuration.
in: body
required: true
type: string
deploy_status:
description: |
The deploy status of the subcloud.
in: body
required: true
type: string
endpoint_sync_status:
description: |
A list of endpoint sync status.
in: body
required: true
type: list
external_oam_floating_address:
description: |
The external OAM Floating IP of the subcloud.
in: body
required: false
type: string
external_oam_gateway_address:
description: |
The external OAM Gateway address of the subcloud.
in: body
required: false
type: string
external_oam_subnet:
description: |
The external OAM subnet of the subcloud.
in: body
required: false
type: string
extra_args:
description: |
The dictionary of extra arguments passed to a sw-update-strategy.
in: body
required: false
type: dictionary
group_id:
description: |
The ID of a subcloud group. Default is 1.
in: body
required: true
type: integer
install_values:
description: |
The content of a file containing install variables such as subcloud
bootstrap interface and BMC information.
in: body
required: false
type: string
major_alarms:
description: |
Number of major alarms for subcloud (-1 when cloud_status is disabled).
in: body
required: true
type: integer
management_end_ip:
description: |
End of management IP address range for subcloud.
in: body
required: true
type: string
management_gateway_ip:
description: |
Management gateway IP for subcloud.
in: body
required: true
type: string
management_start_ip:
description: |
Start of management IP address range for subcloud.
in: body
required: true
type: string
management_state:
description: |
Management state of the subcloud.
in: body
required: true
type: string
management_subnet:
description: |
The management subnet for subcloud.
in: body
required: true
type: string
max_parallel_subclouds:
description: |
The maximum number of subclouds to update in parallel.
in: body
required: false
type: integer
max_parallel_workers:
description: |
The maximum number of workers within a subcloud to update in parallel.
in: body
required: true
type: integer
migrate:
description: |
A flag indicating if the subcloud is migrated
in: body
required: false
type: boolean
minor_alarms:
description: |
Number of minor alarms for subcloud (-1 when cloud_status is disabled).
in: body
required: true
type: integer
oam_floating_ip:
description: |
The OAM Floating IP of the subcloud.
in: body
required: false
type: string
openstack_installed:
description: |
A flag indicating if openstack is installed in the subcloud.
in: body
required: true
type: boolean
region_name:
description: |
The name provisioned for the subcloud (synonym for subcloud name).
in: body
required: true
type: string
restore_values:
description: |
The content of a file containing restore parameters (e.g. backup_filename).
in: body
required: true
type: string
software_version:
description: |
The software version for the subcloud.
in: body
required: true
type: string
stop_on_failure:
description: |
Flag to indicate if the update should stop updating additional subclouds
if a failure is encountered.
in: body
required: false
type: boolean
storage_apply_type:
description: |
The apply type for the update on storage nodes in a subcloud.
Valid values are: `serial` or `parallel`.
in: body
required: true
type: string
strategy_step_details:
description: |
The details associated with the strategy step.
in: body
required: false
type: string
strategy_step_finished_at:
description: |
The time when the strategy_step finished.
in: body
required: true
type: string
strategy_step_id:
description: |
The ID of the strategy step.
in: body
required: false
type: integer
strategy_step_stage:
description: |
The stage associated with the strategy step.
in: body
required: false
type: integer
strategy_step_started_at:
description: |
The time when the strategy_step finished.
in: body
required: true
type: string
strategy_step_state:
description: |
The state of the strategy step.
in: body
required: false
type: string
strategy_steps:
description: |
The list of strategy steps.
in: body
required: false
type: array
subcloud_apply_type:
description: |
The apply type for the update. `serial` or `parallel`.
in: body
required: false
type: string
subcloud_deploy:
description: |
The dictionary of subcloud deploy files.
in: body
required: false
type: dictionary
subcloud_deploy_chart:
description: |
The file name of the deployment manager helm charts.
in: body
required: false
type: string
subcloud_deploy_chart_content:
description: |
The content of the deployment manager helm charts.
in: body
required: false
type: string
subcloud_deploy_overrides:
description: |
The file name of the deployment manager overrides.
in: body
required: false
type: string
subcloud_deploy_overrides_content:
description: |
The content of the deployment manager overrides.
in: body
required: false
type: string
subcloud_deploy_playbook:
description: |
The file name of the deployment manager playbook.
in: body
required: false
type: string
subcloud_deploy_playbook_content:
description: |
The content of the deployment manager playbook.
in: body
required: false
type: string
subcloud_description:
description: |
The description of a subcloud.
in: body
required: false
type: string
subcloud_endpoint:
description: |
The endpoint that is being updated. Only supported value is: `dc-cert`.
in: body
required: true
type: string
subcloud_endpoint_status:
description: |
The endpoint sync status. `in-sync`, `out-of-sync`, `unknown`.
in: body
required: true
type: string
subcloud_endpoint_update_result:
description: |
The result of a subcloud endpoint being updated. `OK`
in: body
required: true
type: string
subcloud_group_description:
description: |
The description of the subcloud group.
in: body
required: false
type: integer
subcloud_group_id:
description: |
The ID of the subcloud group associated with this object.
in: body
required: false
type: integer
subcloud_group_max_parallel_subclouds:
description: |
The maximum number of subclouds in the subcloud group to update in parallel.
in: body
required: false
type: integer
subcloud_group_name:
description: |
The name of the subcloud group.
in: body
required: true
type: integer
subcloud_group_update_apply_type:
description: |
The method for applying an update to this subcloud group.
`serial` or `parallel`.
in: body
required: false
type: string
subcloud_groups:
description: |
The list of ``subcloud-group`` objects.
in: body
required: true
type: array
subcloud_id:
description: |
The ID of a subcloud as an integer.
in: body
required: true
type: integer
subcloud_location:
description: |
The location of a subcloud.
in: body
required: false
type: string
subcloud_management_state:
description: |
Management state of the subcloud.
in: body
required: false
type: string
subcloud_name:
description: |
The name of a subcloud.
in: body
required: true
type: string
subcloud_uuid:
description: |
The ID of a subcloud as a uuid.
in: body
required: true
type: string
subclouds:
description: |
The list of ``subcloud`` objects.
in: body
required: true
type: array
sw_update_options:
description: |
The list of ``sw-update-options`` objects.
in: body
required: false
type: array
sw_update_options_id:
description: |
A numerical ID for sw-update-options. This ID is invalid.
in: body
required: false
type: integer
sw_update_options_name:
description: |
The name of the subcloud to which the sw update options apply.
in: body
required: false
type: string
sw_update_options_subcloud_id:
description: |
The id of the subcloud (will be 0 for: all clouds default).
in: body
required: false
type: integer
sw_update_strategy_action:
description: |
Perform an action on the update strategy.
Valid values are: `apply`, or `abort`.
in: body
required: true
type: string
sw_update_strategy_id:
description: |
The ID of the sw-update-strategy associated with this object.
in: body
required: false
type: integer
sw_update_strategy_state:
description: |
The internal state of the sw-update-strategy.
in: body
required: false
type: string
sync_status:
description: |
The sync status for the endpoint.
in: body
required: true
type: string
sync_status_type:
description: |
The type for the sync status endpoint.
in: body
required: true
type: string
sysadmin_password:
description: |
The sysadmin password of the subcloud. Must be base64 encoded.
in: body
required: true
type: string
system_mode:
description: |
The system mode for the subcloud. (simplex, duplex, duplex-direct)
in: body
required: true
type: string
systemcontroller_gateway_ip:
description: |
The gateway IP address of the system controller of the subcloud.
in: body
required: true
type: string
updated_at:
description: |
The time when the object was updated.
in: body
required: true
type: string
warnings:
description: |
Number of warnings for subcloud (-1 when cloud_status is disabled).
in: body
required: true
type: integer
with_install:
description: |
The flag to indicate whether remote install is required or not (e.g. true).
in: body
required: false
type: boolean
worker_apply_type:
description: |
The apply type for the update on worker nodes in a subcloud.
Valid values are: `serial` or `parallel`.
in: body
required: true
type: string

13
api-ref/source/samples/alarms/alarms-get-response.json Normal file
View File

@ -0,0 +1,13 @@
{
"alarm_summary": [
{
"cloud_status": "disabled",
"region_name": "subcloud1",
"warnings": -1,
"minor_alarms": -1,
"critical_alarms": -1,
"major_alarms": -1,
"uuid": "fd1e38dc-ed76-4b82-906e-e593ed0f8ac8"
}
]
}

15
api-ref/source/samples/root-get-response.json Normal file
View File

@ -0,0 +1,15 @@
{
"versions": [
{
"status": "CURRENT",
"updated": "2017-10-2",
"id": "v1.0",
"links": [
{
"href": "http://192.168.204.2:8119/v1.0/",
"rel": "self"
}
]
}
]
}

8
api-ref/source/samples/subcloud-deploy/subcloud-deploy-get-response.json Normal file
View File

@ -0,0 +1,8 @@
{
"subcloud_deploy":
{
"deploy_chart": "deployment-manager.tgz",
"deploy_playbook": "deployment-manager-playbook.yaml",
"deploy_overrides": "deployment-manager-overrides-subcloud.yaml"
}
}

5
api-ref/source/samples/subcloud-deploy/subcloud-deploy-post-request.json Normal file
View File

@ -0,0 +1,5 @@
{
"deploy_chart": "deployment manager contents",
"deploy_playbook": "deployment manager playbook contents",
"deploy_overrides": "deployment manager overrides contents"
}

5
api-ref/source/samples/subcloud-deploy/subcloud-deploy-post-response.json Normal file
View File

@ -0,0 +1,5 @@
{
"deploy_chart": "deployment-manager.tgz",
"deploy_playbook": "deployment-manager-playbook.yaml",
"deploy_overrides": "deployment-manager-overrides-subcloud.yaml"
}

9
api-ref/source/samples/subcloud-groups/subcloud-group-get-response.json Normal file
View File

@ -0,0 +1,9 @@
{
"id": 2,
"name": "GroupX",
"description": "A new group",
"max_parallel_subclouds": "3",
"update_apply_type": "parallel",
"created-at": "2020-04-08 15:15:10.750592",
"updated-at": null
}

5
api-ref/source/samples/subcloud-groups/subcloud-group-patch-request.json Normal file
View File

@ -0,0 +1,5 @@
{
"description": "A new group description",
"update_apply_type": "serial",
"max_parallel_subclouds": 5
}

9
api-ref/source/samples/subcloud-groups/subcloud-group-patch-response.json Normal file
View File

@ -0,0 +1,9 @@
{
"id": 2,
"name": "GroupX",
"description": "A new group description",
"max_parallel_subclouds": "5",
"update_apply_type": "serial",
"created-at": "2020-04-08 15:15:10.750592",
"updated-at": "2020-04-08 15:21:01.527101"
}

13
api-ref/source/samples/subcloud-groups/subcloud-groups-get-response.json Normal file
View File

@ -0,0 +1,13 @@
{
"subcloud_groups": [
{
"id": 1,
"name": "Default",
"description": "Default Subcloud Group",
"max_parallel_subclouds": 2,
"update_apply_type": "parallel",
"created-at": null,
"updated-at": null
},
]
}

26
api-ref/source/samples/subcloud-groups/subcloud-groups-get-subclouds-response.json Normal file
View File

@ -0,0 +1,26 @@
{
"subclouds": [
{
"id": 1,
"subcloud_id": 1,
"group_id": 1,
"name": "subcloud1",
"description": "Ottawa Site",
"location": "YOW",
"software-version": "21.12",
"availability-status": "online",
"deploy-status": "complete",
"openstack-installed": false,
"management-state": "managed",
"systemcontroller-gateway-ip": "192.168.204.101",
"management-start-ip": "192.168.101.2",
"management-end-ip": "192.168.101.50",
"management-subnet": "192.168.101.0/24",
"management-gateway-ip": "192.168.101.1",
"created-at": "2021-10-04 15:04:13.045076",
"updated-at": "2021-10-25 21:16:23.713858",
"data_install": null,
"data_upgrade": null,
},
]
}

6
api-ref/source/samples/subcloud-groups/subcloud-groups-post-request.json Normal file
View File

@ -0,0 +1,6 @@
{
"name": "GroupX",
"description": "A new group",
"update_apply_type": "parallel",
"max_parallel_subclouds": 3
}

9
api-ref/source/samples/subcloud-groups/subcloud-groups-post-response.json Normal file
View File

@ -0,0 +1,9 @@
{
"id": 2,
"name": "GroupX",
"description": "A new group",
"max_parallel_subclouds": "3",
"update_apply_type": "parallel",
"created-at": "2020-04-08 15:15:10.750592",
"updated-at": null
}

56
api-ref/source/samples/subclouds/subcloud-get-detail-response.json Normal file
View File

@ -0,0 +1,56 @@
{
"id": 1,
"group_id": 1,
"name": "subcloud1",
"description": "Ottawa Site",
"location": "YOW",
"software-version": "21.12",
"availability-status": "online",
"deploy-status": "complete",
"openstack-installed": false,
"management-state": "managed",
"systemcontroller-gateway-ip": "192.168.204.101",
"management-start-ip": "192.168.101.2",
"management-end-ip": "192.168.101.50",
"management-subnet": "192.168.101.0/24",
"management-gateway-ip": "192.168.101.1",
"created-at": "2021-10-04 15:04:13.045076",
"updated-at": "2021-10-25 21:16:23.713858",
"data_install": null,
"data_upgrade": null,
"oam_floating_ip": "192.168.101.2",
"endpoint_sync_status": [
{
"sync_status": "in-sync",
"endpoint_type": "dc-cert"
},
{
"sync_status": "in-sync",
"endpoint_type": "load"
},
{
"sync_status": "in-sync",
"endpoint_type": "firmware"
},
{
"sync_status": "in-sync",
"endpoint_type": "kubernetes"
},
{
"sync_status": "in-sync",
"endpoint_type": "kube-rootca"
},
{
"sync_status": "in-sync",
"endpoint_type": "platform"
},
{
"sync_status": "in-sync",
"endpoint_type": "identity"
},
{
"sync_status": "out-of-sync",
"endpoint_type": "patching"
}
],
}

55
api-ref/source/samples/subclouds/subcloud-get-response.json Normal file
View File

@ -0,0 +1,55 @@
{
"id": 1,
"group_id": 1,
"name": "subcloud1",
"description": "Ottawa Site",
"location": "YOW",
"software-version": "21.12",
"availability-status": "online",
"deploy-status": "complete",
"openstack-installed": false,
"management-state": "managed",
"systemcontroller-gateway-ip": "192.168.204.101",
"management-start-ip": "192.168.101.2",
"management-end-ip": "192.168.101.50",
"management-subnet": "192.168.101.0/24",
"management-gateway-ip": "192.168.101.1",
"created-at": "2021-10-04 15:04:13.045076",
"updated-at": "2021-10-25 21:16:23.713858",
"data_install": null,
"data_upgrade": null,
"endpoint_sync_status": [
{
"sync_status": "in-sync",
"endpoint_type": "dc-cert"
},
{
"sync_status": "in-sync",
"endpoint_type": "load"
},
{
"sync_status": "in-sync",
"endpoint_type": "firmware"
},
{
"sync_status": "in-sync",
"endpoint_type": "kubernetes"
},
{
"sync_status": "in-sync",
"endpoint_type": "kube-rootca"
},
{
"sync_status": "in-sync",
"endpoint_type": "platform"
},
{
"sync_status": "in-sync",
"endpoint_type": "identity"
},
{
"sync_status": "out-of-sync",
"endpoint_type": "patching"
}
],
}

5
api-ref/source/samples/subclouds/subcloud-patch-reconfigure-request.json Normal file
View File

@ -0,0 +1,5 @@
{
"sysadmin_password": "XXXXXXX",
"deploy_config": "path to some file"
}

21
api-ref/source/samples/subclouds/subcloud-patch-reconfigure-response.json Normal file
View File

@ -0,0 +1,21 @@
{
"id": 1,
"name": "subcloud1",
"created-at": "2021-11-08T18:41:19.530228",
"updated-at": "2021-11-15T14:15:59.944851",
"availability-status": "online",
"data_install": null,
"data_upgrade": null,
"deploy-status": "complete",
"description": "Ottawa Site",
"group_id": 1,
"location": "YOW",
"management-end-ip": "192.168.101.50",
"management-gateway-ip": "192.168.101.1",
"management-start-ip": "192.168.101.2",
"management-state": "unmanaged",
"management-subnet": "192.168.101.0/24",
"openstack-installed": false,
"software-version": "21.12",
"systemcontroller-gateway-ip": "192.168.204.101",
}

5
api-ref/source/samples/subclouds/subcloud-patch-reinstall-request.json Normal file
View File

@ -0,0 +1,5 @@
{
"sysadmin_password": "XXXXXXX",
"bootstrap_values": "path to boostrap file",
"deploy_config": "path to deploy file"
}

23
api-ref/source/samples/subclouds/subcloud-patch-reinstall-response.json Normal file
View File

@ -0,0 +1,23 @@
{
"id": 1,
"name": "subcloud1",
"created-at": "2021-11-08T18:41:19.530228",
"updated-at": "2021-11-15T14:15:59.944851",
"availability-status": "online",
"data_install": {
"bootstrap_interface": "eno1"
}
"data_upgrade": null,
"deploy-status": "complete",
"description": "Ottawa Site",
"group_id": 1,
"location": "YOW",
"management-end-ip": "192.168.101.50",
"management-gateway-ip": "192.168.101.1",
"management-start-ip": "192.168.101.2",
"management-state": "unmanaged",
"management-subnet": "192.168.101.0/24",
"openstack-installed": false,
"software-version": "21.12",
"systemcontroller-gateway-ip": "192.168.204.101",
}

3
api-ref/source/samples/subclouds/subcloud-patch-request.json Normal file
View File

@ -0,0 +1,3 @@
{
"management-state": "unmanaged"
}

21
api-ref/source/samples/subclouds/subcloud-patch-response.json Normal file
View File

@ -0,0 +1,21 @@
{
"id": 1,
"name": "subcloud1",
"created-at": "2021-11-08T18:41:19.530228",
"updated-at": "2021-11-15T14:15:59.944851",
"availability-status": "online",
"data_install": null,
"data_upgrade": null,
"deploy-status": "complete",
"description": "Ottawa Site",
"group_id": 1,
"location": "YOW",
"management-end-ip": "192.168.101.50",
"management-gateway-ip": "192.168.101.1",
"management-start-ip": "192.168.101.2",
"management-state": "unmanaged",
"management-subnet": "192.168.101.0/24",
"openstack-installed": false,
"software-version": "21.12",
"systemcontroller-gateway-ip": "192.168.204.101",
}

5
api-ref/source/samples/subclouds/subcloud-patch-restore-request.json Normal file
View File

@ -0,0 +1,5 @@
{
"sysadmin_password": "XXXXXXX",
"restore_values": "path to some file",
"with_install": false
}

23
api-ref/source/samples/subclouds/subcloud-patch-restore-response.json Normal file
View File

@ -0,0 +1,23 @@
{
"id": 1,
"name": "subcloud1",
"created-at": "2021-11-08T18:41:19.530228",
"updated-at": "2021-11-15T14:15:59.944851",
"availability-status": "offline",
"data_install": {
"bootstrap_interface": "eno1"
},
"data_upgrade": null,
"deploy-status": "pre-restore",
"description": "Ottawa Site",
"group_id": 1,
"location": "YOW",
"management-end-ip": "192.168.101.50",
"management-gateway-ip": "192.168.101.1",
"management-start-ip": "192.168.101.2",
"management-state": "unmanaged",
"management-subnet": "192.168.101.0/24",
"openstack-installed": false,
"software-version": "21.12",
"systemcontroller-gateway-ip": "192.168.204.101",
}

4
api-ref/source/samples/subclouds/subcloud-patch-update_status-request.json Normal file
View File

@ -0,0 +1,4 @@
{
"endpoint": "dc-cert",
"status": "in-sync"
}

3
api-ref/source/samples/subclouds/subcloud-patch-update_status-response.json Normal file
View File

@ -0,0 +1,3 @@
{
"result": "OK"
}

61
api-ref/source/samples/subclouds/subclouds-get-response.json Normal file
View File

@ -0,0 +1,61 @@
{
"subclouds": [
{
"id": 1,
"subcloud_id": 1,
"group_id": 1,
"name": "subcloud1",
"description": "Ottawa Site",
"location": "YOW",
"software-version": "21.12",
"availability-status": "online",
"deploy-status": "complete",
"openstack-installed": false,
"management-state": "managed",
"systemcontroller-gateway-ip": "192.168.204.101",
"management-start-ip": "192.168.101.2",
"management-end-ip": "192.168.101.50",
"management-subnet": "192.168.101.0/24",
"management-gateway-ip": "192.168.101.1",
"created-at": "2021-10-04 15:04:13.045076",
"updated-at": "2021-10-25 21:16:23.713858",
"data_install": null,
"data_upgrade": null,
"sync_status": "out-of-sync",
"endpoint_sync_status": [
{
"sync_status": "in-sync",
"endpoint_type": "dc-cert"
},
{
"sync_status": "in-sync",
"endpoint_type": "load"
},
{
"sync_status": "in-sync",
"endpoint_type": "firmware"
},
{
"sync_status": "in-sync",
"endpoint_type": "kubernetes"
},
{
"sync_status": "in-sync",
"endpoint_type": "kube-rootca"
},
{
"sync_status": "in-sync",
"endpoint_type": "platform"
},
{
"sync_status": "in-sync",
"endpoint_type": "identity"
},
{
"sync_status": "out-of-sync",
"endpoint_type": "patching"
}
],
}
]
}

17
api-ref/source/samples/subclouds/subclouds-post-request.json Normal file
View File

@ -0,0 +1,17 @@
{
"name": "subcloud1",
"system_mode": "simplex",
"management_subnet": "192.168.101.0/24",
"management_start_address": "192.168.101.2",
"management_end_address": "192.168.101.50",
"management_gateway_address": "192.168.101.1",
"systemcontroller_gateway_address": "192.168.204.101"
"external_oam_subnet": "10.10.10.0/24",
"external_oam_gateway_address": "10.10.10.1",
"external_oam_floating_address": "10.10.10.12",
"sysadmin_password": "XXXXXXX",
"bootstrap-address": "10.10.10.12",
"description": "Subcloud 1"
"location": "Somewhere"
}

17
api-ref/source/samples/subclouds/subclouds-post-response.json Normal file
View File

@ -0,0 +1,17 @@
{
"description": "A subcloud",
"management-start-ip": "192.168.205.110",
"created-at": "2018-02-25T22:17:11.845596",
"updated-at": null,
"software-version": "18.01",
"management-state": "unmanaged",
"availability-status": "offline",
"systemcontroller-gateway-ip": "192.168.204.102",
"location": "Somewhere",
"group_id": 1,
"management-subnet": "192.168.205.0/24",
"management-gateway-ip": "192.168.205.1",
"management-end-ip": "192.168.205.160",
"id": 4,
"name": "subcloud7"
}

12
api-ref/source/samples/sw-update-options/sw-update-options-get-one-response.json Normal file
View File

@ -0,0 +1,12 @@
{
"id": 1,
"name": "all clouds default",
"subcloud-id": null,
"worker-apply-type": "parallel",
"default-instance-action": "migrate",
"created-at": null,
"updated-at": null,
"max-parallel-workers": 10,
"alarm-restriction-type": "relaxed",
"storage-apply-type": "parallel"
}

28
api-ref/source/samples/sw-update-options/sw-update-options-get-response.json Normal file
View File

@ -0,0 +1,28 @@
{
"sw-update-options": [
{
"worker-apply-type": "parallel",
"name": "all clouds default",
"default-instance-action": "migrate",
"created-at": null,
"subcloud-id": null,
"updated-at": null,
"max-parallel-workers": 10,
"id": 1,
"alarm-restriction-type": "relaxed",
"storage-apply-type": "parallel"
},
{
"worker-apply-type": "parallel",
"name": "subcloud1",
"default-instance-action": "migrate",
"created-at": "2022-01-13 15:10:37.713254",
"subcloud-id": 4,
"updated-at": null,
"max-parallel-workers": 2,
"id": 1,
"alarm-restriction-type": "strict",
"storage-apply-type": "parallel"
}
]
}

7
api-ref/source/samples/sw-update-options/sw-update-options-post-request.json Normal file
View File

@ -0,0 +1,7 @@
{
"alarm-restriction-type": "strict",
"default-instance-action": "migrate",
"max-parallel-workers": 2,
"storage-apply-type": "parallel",
"worker-apply-type": "parallel"
}

12
api-ref/source/samples/sw-update-options/sw-update-options-post-response.json Normal file
View File

@ -0,0 +1,12 @@
{
"id": 1,
"worker-apply-type": "parallel",
"name": "subcloud1",
"default-instance-action": "migrate",
"created-at": "2022-01-13 15:10:37.713254",
"subcloud-id": 4,
"updated-at": null,
"max-parallel-workers": 2,
"alarm-restriction-type": "strict",
"storage-apply-type": "parallel"
}

11
api-ref/source/samples/sw-update-strategy/sw-update-strategy-delete-response.json Normal file
View File

@ -0,0 +1,11 @@
{
"max-parallel-subclouds": null,
"extra-args": {"to-version": null},
"created-at": "2022-01-12T19:13:20.462279",
"updated-at": "2022-01-12T19:15:22.167975",
"subcloud-apply-type": null,
"state": "deleting",
"stop-on-failure": false,
"type": "kubernetes",
"id": 5
}

11
api-ref/source/samples/sw-update-strategy/sw-update-strategy-get-response.json Normal file
View File

@ -0,0 +1,11 @@
{
"type": "patch",
"id": 2,
"state": "initial",
"stop-on-failure": true,
"max-parallel-subclouds": "2",
"subcloud-apply-type": "serial",
"extra-args": null,
"created-at": "2018-02-25T23:23:53.852473",
"updated-at": null
}

11
api-ref/source/samples/sw-update-strategy/sw-update-strategy-get-step-subcloud-response.json Normal file
View File

@ -0,0 +1,11 @@
{
"started-at": null,
"state": "initial",
"details": "",
"finished-at": null,
"updated-at": null,
"created-at": "2022-01-12 19:19:03.782236",
"id": 3,
"cloud": "subcloud1",
"stage": 1
}

15
api-ref/source/samples/sw-update-strategy/sw-update-strategy-get-steps-response.json Normal file
View File

@ -0,0 +1,15 @@
{
"strategy-steps": [
{
"started-at": null,
"state": "initial",
"details": "",
"finished-at": null,
"updated-at": null,
"created-at": "2022-01-12 19:19:03.782236",
"id": 2,
"cloud": "subcloud1",
"stage": 1
}
]
}

3
api-ref/source/samples/sw-update-strategy/sw-update-strategy-post-action-request.json Normal file
View File

@ -0,0 +1,3 @@
{
"action": "apply"
}

13
api-ref/source/samples/sw-update-strategy/sw-update-strategy-post-action-response.json Normal file
View File

@ -0,0 +1,13 @@
{
"id": 7,
"type": "kubernetes",
"state": "applying",
"max-parallel-subclouds": null,
"extra-args": {
"to-version": null
},
"created-at": "2022-01-12T20:39:08.036660",
"updated-at": "2022-01-13T14:19:14.717456",
"subcloud-apply-type": null,
"stop-on-failure": false
}

6
api-ref/source/samples/sw-update-strategy/sw-update-strategy-post-request.json Normal file
View File

@ -0,0 +1,6 @@
{
"subcloud-apply-type": "serial",
"type": "patch",
"stop-on-failure": "true",
"max-parallel-subclouds": 2
}

11
api-ref/source/samples/sw-update-strategy/sw-update-strategy-post-response.json Normal file
View File

@ -0,0 +1,11 @@
{
"type": "patch",
"id": 2,
"state": "initial",
"stop-on-failure": true,
"max-parallel-subclouds": "2",
"subcloud-apply-type": "serial",
"extra-args": null,
"created-at": "2018-02-25T23:23:53.852473",
"updated-at": null
}