Skip to content

Commit

Permalink
Address copy changes
Browse files Browse the repository at this point in the history
  • Loading branch information
StephenVarela committed Nov 26, 2024
1 parent 8db593c commit 7d139c6
Show file tree
Hide file tree
Showing 15 changed files with 46 additions and 65 deletions.
8 changes: 3 additions & 5 deletions specification/DigitalOcean-public.v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,9 @@ tags:
- name: Autoscale Pools
description: |-
Droplet Autoscaling is a new DigitalOcean product that manages the horizontal scaling of customers' applications based on resource usage or a static configuration.
Customers create one or many autoscaling pools. An autoscaling pool has 2 components, scaling configuration and a droplet template.
To use Autoscaling you will need to use an image that automatically runs your application when the Droplet starts or pass a cloud-config in the user_data parameter of the Droplet template.
**Droplet autoscaling will only be supported with Dedicated CPU droplets**
Autoscale for droplets manages horizontal scaling for your applications based on resource usage or a static configuration.
When you use autoscaling, you create one or more autoscaling pools. An autoscaling pool has 2 components: scaling configuration, which determines how the pool scales up and down,
and a Droplet template, which defines the configuration of the Droplets in the pool.
- name: Billing
description: |-
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,9 @@ operationId: autoscale_pool_create
summary: Create a New Autoscale Pool

description: |
To create a new Autoscale Pool, send a POST request to `/v2/droplets/autoscale` setting the
required attributes.
To create a new autoscale pool, send a POST request to `/v2/droplets/autoscale` setting the required attributes.
An Autoscale Pool will be created using the provided information. The response body
will contain a JSON object with a key called `autoscale_pool`. The value will be an
object containing the standard attributes for your new Autoscale Pool.
The response body will contain a JSON object with a key called `autoscale_pool` containing the standard attributes for the new autoscale pool.
tags:
- Autoscale Pools
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ operationID: autoscale_delete
summary: Delete autoscale pool

description: |
To destroy an Autoscale Pool, send a
DELETE request to the `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID`
endpoint.
To destroy an autoscale pool, send a DELETE request to the `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID` endpoint.
A successful response will include a 202 response code and no content.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,8 @@ operationID: autoscale_delete_dangerouts
summary: Delete autoscale pool and resources

description: |
To destroy an Autoscale Pool, send a
DELETE request to the `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID/dangerous`
endpoint. This will delete an autoscale pool and all of the underlying resources
(droplets)
A successful response will include a 202 response code and no content.
To destroy an autoscale pool and its associated resources (Droplets),
send a DELETE request to the `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID/dangerous` endpoint.
tags:
- Autoscale Pools
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@ operationId: autoscale_pools_list
summary: List All Autoscale Pools

description: |
To list all Autoscale Pools in your account, send a GET request to `/v2/droplets/autoscale`.
The response body will be a JSON object with a key of `autoscale_pools`. This will be
set to an array containing objects each representing an Autoscale Pool. These will
contain the standard Autoscale Pool attributes.
To list all autoscale pools in your team, send a GET request to `/v2/droplets/autoscale`.
The response body will be a JSON object with a key of `autoscale_pools` containing an array of autoscale pool objects.
These each contain the standard autoscale pool attributes.
tags:
- Autoscale Pools
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: |
To list the members (resources) in an autoscale pool, send a GET request to `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID/members`.
The response body will be a JSON object with a key of `droplets`. This will be
set to an array containing information about each of the droplets in the autoscale pool.
set to an array containing information about each of the Droplets in the autoscale pool.
tags:
- Autoscale Pools
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ properties:
name:
type: string
example: my-droplet-name
description: "The name(s) to be applied to all droplets in the autoscale pool."
description: "The name(s) to be applied to all Droplets in the autoscale pool."

region:
type: string
Expand All @@ -21,53 +21,52 @@ properties:
- tor1
- blr1
- syd1
description: The datacenter in which all of the droplets will be created.
description: The datacenter in which all of the Droplets will be created.

size:
type: string
example: c-2
description: The droplet size to be used for all droplets in the autoscale pool.
You may specify the slug or the image id. **Note that only dedicated cpus will be supported with autoscale pools.**
description: The Droplet size to be used for all Droplets in the autoscale pool.
You may specify the slug or the image ID.

ssh_keys:
type: array
items:
type: string
example: "88:66:90:d2:68:d5:b5:85:e3:26:26:11:31:57:e6:f8"
description: Used to specify which keys should be installed on the droplets. You can either specify the key id or the fingerprint.
description: The SSH keys to be installed on the Droplets in the autoscale pool. You can either specify the key ID or the fingerprint.

tags:
type: array
items:
type: string
example: my-tag
description: Used to apply tags to each of the droplets in the autoscale pool.
description: The tags to apply to each of the Droplets in the autoscale pool.

vpc_uuid:
type: string
description: Used to specify the VPC where the droplets will be created. Note that the VPC needs to exist in the region you intend to create the droplets in.
description: The VPC where the Droplets in the autoscale pool will be created. The VPC must be in the region where you want to create the Droplets.

with_droplet_agent:
type: boolean
description: Installs the droplet agent. In order for DO to monitor the droplet utilization used for the resource utilization scaling this needs to be set to true.
description: Installs the Droplet agent. This must be set to true to monitor Droplets for resource utilization scaling.

project_id:
type: string
description: Allows you to specify which project the droplets will belong to.
description: The project that the Droplets in the autoscaling pool will belong to.

ipv6:
type: boolean
description: Will assign a unique IPV6 to each of the droplets.
description: Assigns a unique IPv6 address to each of the Droplets in the autoscaling pool.

user_data:
type: string
example: |
#cloud-config
runcmd:
- touch /test.txt
description: A string containing 'user data' which may be used to configure
the Droplet on first boot, often a 'cloud-config' file or Bash script.
It must be plain text and may not exceed 64 KiB in size.
description: A string containing user data that cloud-init consumes to configure a Droplet on first boot.
User data is often a cloud-config file or Bash script. It must be plain text and may not exceed 64 KiB in size.

required:
- name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@ properties:
min_instances:
type: integer
example: 5
description: The lower bound of the number of resources in a dynamically scaling pool.
description: The minimum number of Droplets in an autoscaling pool.
minimum: 0
maximum: 500
max_instances:
type: integer
example: 10
description: The upper bound of the number of resources in a dynamically scaling pool.
description: The maximum number of Droplets in an autoscaling pool.
minimum: 0
maximum: 1000
target_cpu_utilization:
type: float
example: 0.6
description: Target cpu utilization as a decimal.
description: Target CPU utilization as a decimal.
minimum: 0
maximum: 1
target_memory_utilization:
Expand All @@ -26,8 +26,7 @@ properties:
cooldown_minutes:
type: integer
example: 5
description: To prevent thrashing there is a cool down period which may be provided
this will default to 10 minutes if not provided.
description: The number of minutes to wait between scaling events in an autoscaling pool. Defaults to 10 minutes.
minimum: 5
maximum: 20

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ properties:
cpu:
type: float
example: 0.0007338008770232183
description: The average cpu utilization the autoscale pool.
description: The average CPU utilization of the autoscale pool.
minimum: 0
maximum: 1
16 changes: 7 additions & 9 deletions specification/resources/autoscale_pools/models/history.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,37 @@ properties:
history_event_id:
type: string
example: 01936530-4471-7b86-9634-32d8fcfecbc6
description: the unique identifier of the history event
description: The unique identifier of the history event.
current_instance_count:
type: integer
example: 2
description: the current number of instances in the autoscale pool
description: The current number of Droplets in the autoscale pool.
desired_instance_count:
type: integer
example: 2
description: the desired instances for the autoscale pool
description: The target number of Droplets for the autoscale pool after the scaling event.
reason:
type: string
enum:
- CONFIGURATION_CHANGE
- SCALE_UP
- SCALE_DOWN
description: the reason for the scaling event
description: The reason for the scaling event.
status:
type: string
enum:
- in_progress
- success
- error
description: status of the scaling event
description: The status of the scaling event.
created_at:
format: date-time
description: A time value given in ISO8601 combined date and time format
that represents when the History Event was created.
description: The creation time of the history event in ISO8601 combined date and time format.
type: string
example: 2020-07-28T18:00:00Z
updated_at:
format: date-time
description: A time value given in ISO8601 combined date and time format
that represents when the History Event was last updated.
description: The last updated time of the history event in ISO8601 combined date and time format.
type: string
example: 2020-07-28T18:00:00Z

Expand Down
10 changes: 4 additions & 6 deletions specification/resources/autoscale_pools/models/member.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,26 @@ properties:
description: The unique identifier of the droplet.
created_at:
format: date-time
description: A time value given in ISO8601 combined date and time format
that represents when the Resource was created.
description: The creation time of the Droplet in ISO8601 combined date and time format.
type: string
example: 2020-07-28T18:00:00Z
updated_at:
format: date-time
description: A time value given in ISO8601 combined date and time format
that represents when the Resource was last updated.
description: The last updated time of the Droplet in ISO8601 combined date and time format.
type: string
example: 2020-07-28T18:00:00Z
health_status:
type: string
example: 'active'
description: The health status of the resource.
description: The health status of the Droplet.
status:
type: string
enum:
- provisioning
- active
- deleting
- "off"
description: The status of the resource (droplet).
description: The power status of the Droplet.
current_utilization:
$ref: ../models/member_current_utilization.yml

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ properties:
memory:
type: float
example: 0.3588531587713522
description: The memory utilization average of the individual resource.
description: The memory utilization average of the individual Droplet.
cpu:
type: float
example: 0.0007338008770232183
description: The cpu utilization average of the individual resource.
description: The CPU utilization average of the individual Droplet.
2 changes: 1 addition & 1 deletion specification/resources/autoscale_pools/parameters.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
autoscale_pool_id:
in: path
name: autoscale_pool_id
description: A unique identifier for a Autoscale Pool instance.
description: A unique identifier for an autoscale pool.
required: true
schema:
type: string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
description: |
The response will be a JSON object with a key called `autoscale_pool`. This will be
set to a JSON object that contains the standard Autoscale Pool attributes.
set to a JSON object that contains the standard autoscale pool attributes.
headers:
ratelimit-limit:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: A JSON object with a key of `autoscale_pools`.
description: A JSON object with a key of `history`.

headers:
ratelimit-limit:
Expand Down

0 comments on commit 7d139c6

Please sign in to comment.