Skip to content

Commit 47e3247

Browse files
bbiggerrbbiggerr
authored
Merge pull request #679 from bbiggerr/dbaas-remove-mongodb-create
Remove MongoDB Database Create command
2 parents 2b1c1f7 + b31c992 commit 47e3247

File tree

1 file changed

+106
-129
lines changed

1 file changed

+106
-129
lines changed

‎openapi.yaml

Lines changed: 106 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -3218,6 +3218,7 @@ paths:
32183218
- $ref: '#/components/parameters/pageSize'
32193219
description: |
32203220
Display all accessible Managed MongoDB Databases.
3221+
**Note**: New MongoDB Databases cannot currently be created.
32213222
security:
32223223
- personalAccessToken: []
32233224
- oauth:
@@ -3246,99 +3247,99 @@ paths:
32463247
- lang: CLI
32473248
source: >
32483249
linode-cli databases mongodb-list
3249-
post:
3250-
tags:
3251-
- Databases
3252-
summary: Managed MongoDB Database Create
3253-
operationId: postDatabasesMongoDBInstances
3254-
servers:
3255-
- url: https://api.linode.com/v4
3256-
- url: https://api.linode.com/v4beta
3257-
x-linode-cli-action: mongodb-create
3258-
x-linode-grant: add_databases
3259-
description: |
3260-
Provision a Managed MongoDB Database.
3261-
3262-
Restricted Users must have the `add_databases` grant to use this command.
3263-
3264-
New instances can take approximately 15 to 30 minutes to provision.
3265-
3266-
The `allow_list` is used to control access to the Managed Database.
3267-
3268-
* IP addresses on this list can access the Managed Database. All other sources are blocked.
3269-
* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.
3270-
3271-
All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.
3272-
3273-
All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MongoDB Database during configurable maintenance windows.
3274-
3275-
* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.
3276-
3277-
* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.
3278-
3279-
* To modify update the maintenance window for a Database, use the **Managed MongoDB Database Update** ([PUT /databases/mongodb/instances/{instanceId}](/docs/api/databases/#managed-mongodb-database-update)) command.
3280-
3281-
**Note**: Managed MongoDB clusters are currently accessible over public IP addresses. To provide an additional layer of protection, support for private IP addresses is in development.
3282-
security:
3283-
- personalAccessToken: []
3284-
- oauth:
3285-
- databases:read_write
3286-
requestBody:
3287-
description: Information about the Managed MongoDB Database you are creating.
3288-
x-linode-cli-allowed-defaults:
3289-
- region
3290-
- type
3291-
required: true
3292-
content:
3293-
application/json:
3294-
schema:
3295-
$ref: '#/components/schemas/DatabaseMongoDBRequest'
3296-
responses:
3297-
'200':
3298-
description: A new Managed MongoDB Database is provisioning.
3299-
content:
3300-
application/json:
3301-
schema:
3302-
$ref: '#/components/schemas/DatabaseMongoDB'
3303-
default:
3304-
$ref: '#/components/responses/ErrorResponse'
3305-
x-code-samples:
3306-
- lang: Shell
3307-
source: >
3308-
curl -H "Content-Type: application/json" \
3309-
-H "Authorization: Bearer $TOKEN" \
3310-
-X POST -d '{
3311-
"label": "example-db",
3312-
"region": "us-east",
3313-
"type": "g6-dedicated-2",
3314-
"cluster_size": 3,
3315-
"engine": "mongodb/4.4.10",
3316-
"encrypted": false,
3317-
"ssl_connection": false,
3318-
"replica_set": "example-replica-set",
3319-
"compression_type": "none",
3320-
"storage_engine": "wiredtiger",
3321-
"allow_list": [
3322-
"203.0.113.1",
3323-
"192.0.1.0/24"
3324-
]
3325-
}' \
3326-
https://api.linode.com/v4/databases/mongodb/instances
3327-
- lang: CLI
3328-
source: >
3329-
linode-cli databases mongodb-create \
3330-
--label example-db \
3331-
--region us-east \
3332-
--type g6-dedicated-2 \
3333-
--cluster_size 3 \
3334-
--engine mongodb/4.4.10 \
3335-
--encrypted false \
3336-
--ssl_connection true \
3337-
--replica_set example-replica-set \
3338-
--storage_engine wiredtiger \
3339-
--compression_type none \
3340-
--allow_list 203.0.113.1 \
3341-
--allow_list 192.0.1.0/24
3250+
# post:
3251+
# tags:
3252+
# - Databases
3253+
# summary: Managed MongoDB Database Create
3254+
# operationId: postDatabasesMongoDBInstances
3255+
# servers:
3256+
# - url: https://api.linode.com/v4
3257+
# - url: https://api.linode.com/v4beta
3258+
# x-linode-cli-action: mongodb-create
3259+
# x-linode-grant: add_databases
3260+
# description: |
3261+
# Provision a Managed MongoDB Database.
3262+
3263+
# Restricted Users must have the `add_databases` grant to use this command.
3264+
3265+
# New instances can take approximately 15 to 30 minutes to provision.
3266+
3267+
# The `allow_list` is used to control access to the Managed Database.
3268+
3269+
# * IP addresses on this list can access the Managed Database. All other sources are blocked.
3270+
# * Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.
3271+
3272+
# All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.
3273+
3274+
# All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MongoDB Database during configurable maintenance windows.
3275+
3276+
# * If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.
3277+
3278+
# * **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.
3279+
3280+
# * To modify update the maintenance window for a Database, use the **Managed MongoDB Database Update** ([PUT /databases/mongodb/instances/{instanceId}](/docs/api/databases/#managed-mongodb-database-update)) command.
3281+
3282+
# **Note**: Managed MongoDB clusters are currently accessible over public IP addresses. To provide an additional layer of protection, support for private IP addresses is in development.
3283+
# security:
3284+
# - personalAccessToken: []
3285+
# - oauth:
3286+
# - databases:read_write
3287+
# requestBody:
3288+
# description: Information about the Managed MongoDB Database you are creating.
3289+
# x-linode-cli-allowed-defaults:
3290+
# - region
3291+
# - type
3292+
# required: true
3293+
# content:
3294+
# application/json:
3295+
# schema:
3296+
# $ref: '#/components/schemas/DatabaseMongoDBRequest'
3297+
# responses:
3298+
# '200':
3299+
# description: A new Managed MongoDB Database is provisioning.
3300+
# content:
3301+
# application/json:
3302+
# schema:
3303+
# $ref: '#/components/schemas/DatabaseMongoDB'
3304+
# default:
3305+
# $ref: '#/components/responses/ErrorResponse'
3306+
# x-code-samples:
3307+
# - lang: Shell
3308+
# source: >
3309+
# curl -H "Content-Type: application/json" \
3310+
# -H "Authorization: Bearer $TOKEN" \
3311+
# -X POST -d '{
3312+
# "label": "example-db",
3313+
# "region": "us-east",
3314+
# "type": "g6-dedicated-2",
3315+
# "cluster_size": 3,
3316+
# "engine": "mongodb/4.4.10",
3317+
# "encrypted": false,
3318+
# "ssl_connection": false,
3319+
# "replica_set": "example-replica-set",
3320+
# "compression_type": "none",
3321+
# "storage_engine": "wiredtiger",
3322+
# "allow_list": [
3323+
# "203.0.113.1",
3324+
# "192.0.1.0/24"
3325+
# ]
3326+
# }' \
3327+
# https://api.linode.com/v4/databases/mongodb/instances
3328+
# - lang: CLI
3329+
# source: >
3330+
# linode-cli databases mongodb-create \
3331+
# --label example-db \
3332+
# --region us-east \
3333+
# --type g6-dedicated-2 \
3334+
# --cluster_size 3 \
3335+
# --engine mongodb/4.4.10 \
3336+
# --encrypted false \
3337+
# --ssl_connection true \
3338+
# --replica_set example-replica-set \
3339+
# --storage_engine wiredtiger \
3340+
# --compression_type none \
3341+
# --allow_list 203.0.113.1 \
3342+
# --allow_list 192.0.1.0/24
33423343
/databases/mongodb/instances/{instanceId}:
33433344
x-linode-cli-command: databases
33443345
parameters:
@@ -3360,6 +3361,7 @@ paths:
33603361
x-linode-grant: read_only
33613362
description: |
33623363
Display information for a single, accessible Managed MongoDB Database.
3364+
**Note**: New MongoDB Databases cannot currently be created.
33633365
security:
33643366
- personalAccessToken: []
33653367
- oauth:
@@ -3393,12 +3395,10 @@ paths:
33933395
x-linode-grant: read_write
33943396
description: |
33953397
Remove a Managed MongoDB Database from your Account.
3396-
33973398
Requires `read_write` access to the Database.
3398-
33993399
The Database must have an `active`, `failed`, or `degraded` status to perform this command.
3400-
34013400
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
3401+
**Note**: New MongoDB Databases cannot currently be created.
34023402
security:
34033403
- personalAccessToken: []
34043404
- oauth:
@@ -3433,22 +3433,16 @@ paths:
34333433
x-linode-grant: read_write
34343434
description: |
34353435
Update a Managed MongoDB Database.
3436-
34373436
Requires `read_write` access to the Database.
3438-
34393437
The Database must have an `active` status to perform this command.
3440-
34413438
Updating addresses in the `allow_list` overwrites any existing addresses.
3442-
34433439
* IP addresses on this list can access the Managed Database. All other sources are blocked.
34443440
* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.
34453441
* **Note**: Updates to the `allow_list` may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property.
3446-
34473442
All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MongoDB Database. The maintenance window for these updates is configured with the Managed Database's `updates` property.
3448-
34493443
* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.
3450-
34513444
* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.
3445+
**Note**: New MongoDB Databases cannot currently be created.
34523446
security:
34533447
- personalAccessToken: []
34543448
- oauth:
@@ -3532,12 +3526,10 @@ paths:
35323526
- $ref: '#/components/parameters/pageSize'
35333527
description: |
35343528
Display all backups for an accessible Managed MongoDB Database.
3535-
35363529
The Database must not be provisioning to perform this command.
3537-
35383530
Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.
3539-
35403531
Database `snapshot` type backups are created by accessing the **Managed MongoDB Database Backup Snapshot Create** ([POST /databases/mongodb/instances/{instanceId}/backups](/docs/api/databases/#managed-mongodb-database-backup-snapshot-create)) command.
3532+
**Note**: New MongoDB Databases cannot currently be created.
35413533
security:
35423534
- personalAccessToken: []
35433535
- oauth:
@@ -3578,12 +3570,10 @@ paths:
35783570
x-linode-grant: read_write
35793571
description: |
35803572
Creates a snapshot backup of a Managed MongoDB Database.
3581-
35823573
Requires `read_write` access to the Database.
3583-
35843574
Backups generated by this command have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore.
3585-
35863575
The Database must have an `active` status to perform this command.
3576+
**Note**: New MongoDB Databases cannot currently be created.
35873577
security:
35883578
- personalAccessToken: []
35893579
- oauth:
@@ -3603,7 +3593,6 @@ paths:
36033593
maxLength: 64
36043594
description: |
36053595
The label for the Database snapshot backup.
3606-
36073596
* Must use only letters, numbers, underscores, dashes, and periods.
36083597
* Must begin and end with a letter or number.
36093598
* Must not include two dashes, underscores, or periods in a row.
@@ -3616,7 +3605,6 @@ paths:
36163605
default: primary
36173606
description: |
36183607
The Database cluster target.
3619-
36203608
If the Database is a high availability cluster, choosing `secondary` creates a snapshot backup of a replica node.
36213609
example: primary
36223610
responses:
@@ -3669,8 +3657,8 @@ paths:
36693657
x-linode-grant: read_only
36703658
description: |
36713659
Display information for a single backup for an accessible Managed MongoDB Database.
3672-
36733660
The Database must not be provisioning to perform this command.
3661+
**Note**: New MongoDB Databases cannot currently be created.
36743662
security:
36753663
- personalAccessToken: []
36763664
- oauth:
@@ -3704,10 +3692,9 @@ paths:
37043692
x-linode-grant: unrestricted only
37053693
description: |
37063694
Delete a single backup for an accessible Managed MongoDB Database.
3707-
37083695
Requires `read_write` access to the Database.
3709-
37103696
The Database must not be provisioning to perform this command.
3697+
**Note**: New MongoDB Databases cannot currently be created.
37113698
security:
37123699
- personalAccessToken: []
37133700
- oauth:
@@ -3757,14 +3744,11 @@ paths:
37573744
x-linode-grant: read_write
37583745
description: |
37593746
Restore a backup to a Managed MongoDB Database on your Account.
3760-
37613747
Requires `read_write` access to the Database.
3762-
37633748
The Database must have an `active` status to perform this command.
3764-
37653749
**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.
3766-
37673750
**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.
3751+
**Note**: New MongoDB Databases cannot currently be created.
37683752
security:
37693753
- personalAccessToken: []
37703754
- oauth:
@@ -3807,8 +3791,8 @@ paths:
38073791
x-linode-grant: read_only
38083792
description: |
38093793
Display the root username and password for an accessible Managed MongoDB Database.
3810-
38113794
The Database must have an `active` status to perform this command.
3795+
**Note**: New MongoDB Databases cannot currently be created.
38123796
security:
38133797
- personalAccessToken: []
38143798
- oauth:
@@ -3851,14 +3835,11 @@ paths:
38513835
x-linode-grant: read_write
38523836
description: |
38533837
Reset the root password for a Managed MongoDB Database.
3854-
38553838
Requires `read_write` access to the Database.
3856-
38573839
A new root password is randomly generated and accessible with the **Managed MongoDB Database Credentials View** ([GET /databases/mongodb/instances/{instanceId}/credentials](/docs/api/databases/#managed-mongodb-database-credentials-view)) command.
3858-
38593840
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
3860-
38613841
**Note**: Note that it may take several seconds for credentials to reset.
3842+
**Note**: New MongoDB Databases cannot currently be created.
38623843
security:
38633844
- personalAccessToken: []
38643845
- oauth:
@@ -3901,8 +3882,8 @@ paths:
39013882
x-linode-grant: read_only
39023883
description: |
39033884
Display the SSL CA certificate for an accessible Managed MongoDB Database.
3904-
39053885
The Database must have an `active` status to perform this command.
3886+
**Note**: New MongoDB Databases cannot currently be created.
39063887
security:
39073888
- personalAccessToken: []
39083889
- oauth:
@@ -3945,16 +3926,12 @@ paths:
39453926
x-linode-grant: read_write
39463927
description: |
39473928
Apply security patches and updates to the underlying operating system of the Managed MongoDB Database. This function runs during regular maintenance windows, which are configurable with the **Managed MongoDB Database Update** ([PUT /databases/mongodb/instances/{instanceId}](/docs/api/databases/#managed-mongodb-database-update)) command.
3948-
39493929
Requires `read_write` access to the Database.
3950-
39513930
The Database must have an `active` status to perform this command.
3952-
39533931
**Note**
3954-
39553932
* If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance.
3956-
39573933
* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.
3934+
**Note**: New MongoDB Databases cannot currently be created.
39583935
security:
39593936
- personalAccessToken: []
39603937
- oauth:

0 commit comments

Comments
 (0)