| Warning |
|---|
You have tried to access an archived page. Please go to the new https://root360.atlassian.net/wiki/spaces/KB to find more documents. |
...
In order to provide a high degree on management capabilities to you we maintain a command line tool suite. To have a short and handy abbreviation on the command line we named it after our internal short name for root360, r3.
...
If you like to have r3 extended or experience any problems, please feel free to come back to us after consulting this documentation.
Table of contents
| Table of Contents | ||
|---|---|---|
|
Scope of the cloud management CLI suite
The cloud management CLI suite r3 is only available on the Bastion Host/Jump-Server of your environment. It is not available on other instances like Web-Servers. Other independently provided tools may be available on other kinds of systems, but are out of scope.
r3's purpose is:
to ease manual tasks for developers or other representatives of our customers with command line access
to allow integration with customer CI/CD tools for process automation
Proceedings on Pre-r3 scripts and tools
...
The usage of the tools is discouraged, but you don't have to fear that they will go without further notice or will stop working!
Script name | Purpose | Further proceeding |
|---|---|---|
deploy.py | Deploy applications to instances |
|
ec2-instance-ip.sh | Give overview about ec2 instances |
|
update-ecs-service.py | Deploy docker containers to ECS-integrated docker clusters |
|
ecs-instance-list.py | List properties and distribution of containers over container hosts |
|
show-ecs-service-status.py | Gather details about deployments, events and state |
|
varnish-flush.sh | Flush object caches of varnish web accelerators |
|
memcache-flush.py | Flush memcached |
|
rds-snapshot.sh | Create Backup of MySQL database servers |
|
General usage information
...
From the example you can see, that for the example environment operations for only 2 services are available (instance and db).
...
How to invoke the cli tool?
| Code Block | ||
|---|---|---|
| ||
USER@JUMPSERVER:~$ r3
usage: r3
{db,instance}
[kwargs [kwargs ...]]
r3: error: the following arguments are required: cmd |
You can obtain more detailed information for each specific service like shown in the following.
...
How to show help on specific service?
| Code Block | ||
|---|---|---|
| ||
USER@JUMPSERVER:~$ r3 db -h
#Response
Manage Databases on root360 Cloud Platform
optional arguments:
-h, --help show this help message and exit
Command Overview:
{snapshot,list,restore,show,destroy}
snapshot Initiate Snapshot Creation for a Database Servers
list List Database Servers and Snapshots for this
Environment.
restore Create a Restore Database Server from a Snapshot.
show Show Details for Snapshots/Database Servers of this
Environment.
destroy Destroy Restore-Snapshots/Database Servers of this
Environment. |
Furthermore specific information for available operations of each service can be obtained like shown below.
...
How to show details on available operations on a service?
| Code Block | ||
|---|---|---|
| ||
USER@JUMPSERVER:~$ r3 db restore -h
#Response
Create a Restore Database Server from a Snapshot.
optional arguments:
-h, --help show this help message and exit
--loglevel {INFO,DEBUG,ERROR}
Define Loglevel for Execution (default: INFO)
--env ENVIRONMENT, --environment ENVIRONMENT
The Short Name of the desired Environment, e.g test,
prod (default: this environment).
snapshot_id SnapshotIdentifier of a Snapshot to restore a Database
Server from.
--db-instance-class INSTANCE_CLASS
DB instance class of restore database
|
...
The aliases can be differentiated from the services easily. all Aliases are verbs, whilst all services are named by nouns.
Related Articles
| Filter by label (Content by label) | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...
|