magellan-cli 0.4.4 → 0.5.0

data/reference/en/image.md

@@ -0,0 +1,65 @@
+---
+layout: index
+breadcrumb: <a href="/">Top</a> / <a href="/reference">Reference</a> / <a href="/reference/magellan-cli">magellan-cli</a> / image
+---
+
+## Commands
+
+- [magellan-cli list](#list)
+- [magellan-cli show [ID]](#show)
+- [magellan-cli select NAME](#select)
+- [magellan-cli deselect](#deselect)
+- [magellan-cli help [COMMAND]](#help)
+
+## Global Options
+
+```text
+Options:
+  -V, [--verbose]  
+  -D, [--dryrun]   
+  -v, [--version]  
+
+```
+
+
+## Details
+### <a name="list"></a>list
+
+```text
+magellan-cli list
+```
+
+Show a list of the images
+
+### <a name="show"></a>show
+
+```text
+magellan-cli show [ID]
+```
+
+Show the detail of the image specified by ID
+
+### <a name="select"></a>select
+
+```text
+magellan-cli select NAME
+```
+
+Select the image by NAME
+
+### <a name="deselect"></a>deselect
+
+```text
+magellan-cli deselect
+```
+
+Deselect the image
+
+### <a name="help"></a>help
+
+```text
+magellan-cli help [COMMAND]
+```
+
+Describe available commands or one specific command
+

data/reference/en/index.md

@@ -0,0 +1,63 @@
+---
+layout: index
+breadcrumb: <a href="/">Top</a> / <a href="/reference">Reference</a> / <a href="/reference/magellan-cli">magellan-cli</a> / 
+---
+
+## Commands
+
+- [magellan-cli login](#login)
+- [magellan-cli organization SUBCOMMAND ...ARGS](./organization.html)
+- [magellan-cli team SUBCOMMAND ...ARGS](./team.html)
+- [magellan-cli project SUBCOMMAND ...ARGS](./project.html)
+- [magellan-cli stage SUBCOMMAND ...ARGS](./stage.html)
+- [magellan-cli client_version SUBCOMMAND ...ARGS](./client_version.html)
+- [magellan-cli worker SUBCOMMAND ...ARGS](./worker.html)
+- [magellan-cli image SUBCOMMAND ...ARGS](./image.html)
+- [magellan-cli container SUBCOMMAND ...ARGS](./container.html)
+- [magellan-cli cloudsql SUBCOMMAND ...ARGS](./cloudsql.html)
+- [magellan-cli info](#info)
+- [magellan-cli help [COMMAND]](#help)
+
+## Global Options
+
+```text
+Options:
+  -V, [--verbose]  
+  -D, [--dryrun]   
+  -v, [--version]  
+
+```
+
+
+## Details
+### <a name="login"></a>login
+
+```text
+magellan-cli login
+```
+
+```text
+Options:
+  -e, [--email=EMAIL]        # email address for login
+  -p, [--password=PASSWORD]  # password for login
+
+```
+
+Login to the Magellan server
+
+### <a name="info"></a>info
+
+```text
+magellan-cli info
+```
+
+Show login user and selected resources
+
+### <a name="help"></a>help
+
+```text
+magellan-cli help [COMMAND]
+```
+
+Describe available commands or one specific command
+

data/reference/en/organization.md

@@ -0,0 +1,83 @@
+---
+layout: index
+breadcrumb: <a href="/">Top</a> / <a href="/reference">Reference</a> / <a href="/reference/magellan-cli">magellan-cli</a> / organization
+---
+
+## Commands
+
+- [magellan-cli list](#list)
+- [magellan-cli show [ID]](#show)
+- [magellan-cli select NAME](#select)
+- [magellan-cli deselect](#deselect)
+- [magellan-cli delete NAME](#delete)
+- [magellan-cli create NAME](#create)
+- [magellan-cli help [COMMAND]](#help)
+
+## Global Options
+
+```text
+Options:
+  -V, [--verbose]  
+  -D, [--dryrun]   
+  -v, [--version]  
+
+```
+
+
+## Details
+### <a name="list"></a>list
+
+```text
+magellan-cli list
+```
+
+Show a list of the organizations
+
+### <a name="show"></a>show
+
+```text
+magellan-cli show [ID]
+```
+
+Show the detail of the organization specified by ID
+
+### <a name="select"></a>select
+
+```text
+magellan-cli select NAME
+```
+
+Select the organization by NAME
+
+### <a name="deselect"></a>deselect
+
+```text
+magellan-cli deselect
+```
+
+Deselect the organization
+
+### <a name="delete"></a>delete
+
+```text
+magellan-cli delete NAME
+```
+
+Delete the organization specified by NAME
+
+### <a name="create"></a>create
+
+```text
+magellan-cli create NAME
+```
+
+Create a new organization with NAME
+
+### <a name="help"></a>help
+
+```text
+magellan-cli help [COMMAND]
+```
+
+Describe available commands or one specific command
+

data/reference/en/project.md

@@ -0,0 +1,92 @@
+---
+layout: index
+breadcrumb: <a href="/">Top</a> / <a href="/reference">Reference</a> / <a href="/reference/magellan-cli">magellan-cli</a> / project
+---
+
+## Commands
+
+- [magellan-cli list](#list)
+- [magellan-cli show [ID]](#show)
+- [magellan-cli select NAME](#select)
+- [magellan-cli deselect](#deselect)
+- [magellan-cli delete NAME](#delete)
+- [magellan-cli update ATTRIBUTES](#update)
+- [magellan-cli create NAME](#create)
+- [magellan-cli help [COMMAND]](#help)
+
+## Global Options
+
+```text
+Options:
+  -V, [--verbose]  
+  -D, [--dryrun]   
+  -v, [--version]  
+
+```
+
+
+## Details
+### <a name="list"></a>list
+
+```text
+magellan-cli list
+```
+
+Show a list of the projects
+
+### <a name="show"></a>show
+
+```text
+magellan-cli show [ID]
+```
+
+Show the detail of the project specified by ID
+
+### <a name="select"></a>select
+
+```text
+magellan-cli select NAME
+```
+
+Select the project by NAME
+
+### <a name="deselect"></a>deselect
+
+```text
+magellan-cli deselect
+```
+
+Deselect the project
+
+### <a name="delete"></a>delete
+
+```text
+magellan-cli delete NAME
+```
+
+Delete the project specified by NAME
+
+### <a name="update"></a>update
+
+```text
+magellan-cli update ATTRIBUTES
+```
+
+Update the ATTRIBUTES of the selected project
+
+### <a name="create"></a>create
+
+```text
+magellan-cli create NAME
+```
+
+Create a new project with NAME
+
+### <a name="help"></a>help
+
+```text
+magellan-cli help [COMMAND]
+```
+
+Describe available commands or one specific command
+

data/reference/en/stage.md

@@ -0,0 +1,181 @@
+---
+layout: index
+breadcrumb: <a href="/">Top</a> / <a href="/reference">Reference</a> / <a href="/reference/magellan-cli">magellan-cli</a> / stage
+---
+
+## Commands
+
+- [magellan-cli list](#list)
+- [magellan-cli show [ID]](#show)
+- [magellan-cli select NAME](#select)
+- [magellan-cli deselect](#deselect)
+- [magellan-cli delete NAME](#delete)
+- [magellan-cli create NAME [-t development|staging|production|other]](#create)
+- [magellan-cli planning](#planning)
+- [magellan-cli current](#current)
+- [magellan-cli prepare](#prepare)
+- [magellan-cli repair](#repair)
+- [magellan-cli update ATTRIBUTES](#update)
+- [magellan-cli release_now](#release_now)
+- [magellan-cli logs](#logs)
+- [magellan-cli set_container_num NUM](#set_container_num)
+- [magellan-cli reload](#reload)
+- [magellan-cli help [COMMAND]](#help)
+
+## Global Options
+
+```text
+Options:
+  -V, [--verbose]  
+  -D, [--dryrun]   
+  -v, [--version]  
+
+```
+
+
+## Details
+### <a name="list"></a>list
+
+```text
+magellan-cli list
+```
+
+Show a list of the stages
+
+### <a name="show"></a>show
+
+```text
+magellan-cli show [ID]
+```
+
+Show the detail of the stage specified by ID
+
+### <a name="select"></a>select
+
+```text
+magellan-cli select NAME
+```
+
+Select the stage by NAME
+
+### <a name="deselect"></a>deselect
+
+```text
+magellan-cli deselect
+```
+
+Deselect the stage
+
+### <a name="delete"></a>delete
+
+```text
+magellan-cli delete NAME
+```
+
+Delete the stage specified by NAME
+
+### <a name="create"></a>create
+
+```text
+magellan-cli create NAME [-t development|staging|production|other]
+```
+
+```text
+Options:
+  [-t=T]  # -t development|staging|production. specify Stage Type
+          # Default: development
+
+```
+
+Create a new stage with Name and Type
+
+### <a name="planning"></a>planning
+
+```text
+magellan-cli planning
+```
+
+Switch to planning to build next released version
+
+### <a name="current"></a>current
+
+```text
+magellan-cli current
+```
+
+Switch to current released version
+
+### <a name="prepare"></a>prepare
+
+```text
+magellan-cli prepare
+```
+
+Prepare the containers
+
+### <a name="repair"></a>repair
+
+```text
+magellan-cli repair
+```
+
+Repair the stage status
+
+### <a name="update"></a>update
+
+```text
+magellan-cli update ATTRIBUTES
+```
+
+Update the ATTRIBUTES of the selected stage
+
+### <a name="release_now"></a>release_now
+
+```text
+magellan-cli release_now
+```
+
+```text
+Options:
+  [-A]    # -A async mode. release_now returns soon
+  [-i=N]  # -i polling interval(seconds)
+          # Default: 10
+  [-t=N]  # -t timeout(seconds)
+          # Default: 600
+
+```
+
+Release the changes now
+
+### <a name="logs"></a>logs
+
+```text
+magellan-cli logs
+```
+
+Fetch the logs of the workers
+
+### <a name="set_container_num"></a>set_container_num
+
+```text
+magellan-cli set_container_num NUM
+```
+
+Set the number of containers for the selected image
+
+### <a name="reload"></a>reload
+
+```text
+magellan-cli reload
+```
+
+Reload the last selections
+
+### <a name="help"></a>help
+
+```text
+magellan-cli help [COMMAND]
+```
+
+Describe available commands or one specific command
+

data/reference/en/team.md

@@ -0,0 +1,74 @@
+---
+layout: index
+breadcrumb: <a href="/">Top</a> / <a href="/reference">Reference</a> / <a href="/reference/magellan-cli">magellan-cli</a> / team
+---
+
+## Commands
+
+- [magellan-cli list](#list)
+- [magellan-cli show [ID]](#show)
+- [magellan-cli select NAME](#select)
+- [magellan-cli deselect](#deselect)
+- [magellan-cli create NAME ROLE](#create)
+- [magellan-cli help [COMMAND]](#help)
+
+## Global Options
+
+```text
+Options:
+  -V, [--verbose]  
+  -D, [--dryrun]   
+  -v, [--version]  
+
+```
+
+
+## Details
+### <a name="list"></a>list
+
+```text
+magellan-cli list
+```
+
+Show a list of the teams
+
+### <a name="show"></a>show
+
+```text
+magellan-cli show [ID]
+```
+
+Show the detail of the team specified by ID
+
+### <a name="select"></a>select
+
+```text
+magellan-cli select NAME
+```
+
+Select the team by NAME
+
+### <a name="deselect"></a>deselect
+
+```text
+magellan-cli deselect
+```
+
+Deselect the team
+
+### <a name="create"></a>create
+
+```text
+magellan-cli create NAME ROLE
+```
+
+Create a new team with NAME and ROLE
+
+### <a name="help"></a>help
+
+```text
+magellan-cli help [COMMAND]
+```
+
+Describe available commands or one specific command
+

data/reference/en/worker.md

@@ -0,0 +1,107 @@
+---
+layout: index
+breadcrumb: <a href="/">Top</a> / <a href="/reference">Reference</a> / <a href="/reference/magellan-cli">magellan-cli</a> / worker
+---
+
+## Commands
+
+- [magellan-cli list](#list)
+- [magellan-cli show [ID]](#show)
+- [magellan-cli select NAME](#select)
+- [magellan-cli deselect](#deselect)
+- [magellan-cli delete NAME](#delete)
+- [magellan-cli create NAME IMAGE](#create)
+- [magellan-cli update ATTRIBUTES](#update)
+- [magellan-cli prepare_images](#prepare_images)
+- [magellan-cli help [COMMAND]](#help)
+
+## Global Options
+
+```text
+Options:
+  -V, [--verbose]  
+  -D, [--dryrun]   
+  -v, [--version]  
+
+```
+
+
+## Details
+### <a name="list"></a>list
+
+```text
+magellan-cli list
+```
+
+Show a list of the workers
+
+### <a name="show"></a>show
+
+```text
+magellan-cli show [ID]
+```
+
+Show the detail of the worker specified by ID
+
+### <a name="select"></a>select
+
+```text
+magellan-cli select NAME
+```
+
+Select the worker by NAME
+
+### <a name="deselect"></a>deselect
+
+```text
+magellan-cli deselect
+```
+
+Deselect the worker
+
+### <a name="delete"></a>delete
+
+```text
+magellan-cli delete NAME
+```
+
+Delete the worker specified by NAME
+
+### <a name="create"></a>create
+
+```text
+magellan-cli create NAME IMAGE
+```
+
+```text
+Options:
+  -A, [--attributes-yaml=ATTRIBUTES_YAML]  # path to YAML file which defines attributes
+
+```
+
+Create a new worker with NAME and IMAGE
+
+### <a name="update"></a>update
+
+```text
+magellan-cli update ATTRIBUTES
+```
+
+Update the ATTRIBUTES(filename or JSON) of the selected worker
+
+### <a name="prepare_images"></a>prepare_images
+
+```text
+magellan-cli prepare_images
+```
+
+Prepare the images for the selected worker
+
+### <a name="help"></a>help
+
+```text
+magellan-cli help [COMMAND]
+```
+
+Describe available commands or one specific command
+