Difference between revisions of "Solum/FeatureBlueprints/ApplicationDeploymentAndManagement"

Latest revision as of 00:18, 4 December 2013

Blueprint: https://blueprints.launchpad.net/solum/+spec/app-deploy-manage

Solum-R1 application deployment/Management

Solum-R1.1 GIT deployment

As an application developer, I want to push my code to my Git repository, and have the platform automatically detect the code push and generate a running application using the new code. I should be able to deploy a new app, or make updates to an existing app via git.

Solum-R1.2 Fast provisioning

As an application developer, when I deploy my new app or update an existing app on the Solum platform, I should receive the URL of my application in less than a minute.

Solum-R1.3 Dense packing (Infrastructure efficiency)

As a system architect, I want to be able to fit several application instances on the same host, so that I am able to share the same host operating system across multiple application instances.

Solum-R1.4 Application Isolation

As an application developer, I want security+performance isolation for my apps, so that other apps deployed on the same host are not able to intrude into my application container or impact the resources allocated to my app.

Solum-R1.5 assembly scale: CLI

Synopsis: assembly scale <assembly_name> <tag> <increment>

Increase or decrease the number of identical DUs in an assembly by supplying an Assembly name, a tier_name (tag) name, and a increment numeric argument. For example:

assembly scale my_assembly my_tag +1

The above example would increase the DU count by one.

assembly scale my_asssembly my_tag +3

The above example would increase it by three. Negative numbers shall decrease the count, to a minimum of 0. This function will find a tier by locating all components with the named tag in the Assembly and increase or decrease the number of replicas of it in accordance with the signed numeric argument.

A special increment value of "auto=default" starts auto scaling with the "default" policy and a value of "auto=none" stops auto scaling. The "default" policy is: Metric=cpu utilization, Multiple=1, Eviction=oldest du, Cooldown=15 min. Example:

assembly scale my_assembly my_tag auto=default
assembly scale my_assembly my_tag auto=none

The above example enables auto scaling using the "default" scaling policy, and then turns auto scaling back off.

Solum-R1.6 assembly delete: CLI

Synopsis: assembly delete <assembly_name>

As an application developer, I can delete an application deployed on the platform using a CLI command.

Solum-R1.7 Show Commands: CLI

The following API functions query information available from the Solum API.

Solum-R1.7.1 plan show: CLI

Synopsis: plan show <plan_name>

This function shall return detail about the given Plan by name. This information shall include:

• uri
• name
• description
• assemblies (list)

Solum-R1.7.2 assembly show: CLI

Synopsis: assembly show <assembly_name>

This function shall return detail about the given Assembly by name or uri. This information shall include:

• uri
• name
• description
• components (list)
  • detailed listing of each component
• operations (list)
• sensors (list)

Solum-R1.7.3 solum service show: CLI

Synopsis: solum service show <service_name>

This function shall return detail about the given Service by name or uri. This information shall include:

• uri
• name
• description
• operations (list)
• sensors (list)
• read_only (Boolean)

Note: "service show" would conflict with the existing "os service show".

Solum-R1.7.4 app show: CLI

Synopsis: app show <plan_name>

Alias of "plan show" for ease of use. This function shall return detail about the given Plan by name or uri. This information shall include:

• uri
• name
• description
• repo

Solum-R1.8 List Commands: CLI

The following API functions query information available from the Solum API.

Solum-R1.8.1 app list: CLI

Synopsis: app list

List the Plans. (alias of plan list)

Solum-R1.8.2 assembly list: CLI

Synopsis: assembly list

List the Assemblies.

Solum-R1.8.3 solum service list: CLI

Synopsis: solum service list

List the Services. Note: The noun "service" is already used by Keystone, so we need to add "solum" to the beginning to differentiate.

Solum-R1.8.3 plan list: CLI

Synopsis: plan list

List the Plans.

Solum-R1.9 assembly create: CLI

Synopsis: assembly create <--plan=plan_name | --json=json_filename | --yaml=yaml_filename> <assembly_name> Create an Assembly from an Plan by name or id. Multiple Assemblies may be created from a single Plan. Return the URI of the Assembly created. See also: app deploy

Options

• Note: --plan, --json, and --yaml are each mutually exclusive
• If --plan is specified, use the plan from the specifried name.
• If --json is specified, use the plan in the referenced JSON file
• If --yaml is specified, use the plan in the referenced YAML file

Example:

assembly create --plan="my_awesome_app" my_app_01

Solum-R1.10 assembly resize: CLI

Synopsis: assembly resize [--max] <assembly_name> <tag> <size>

Systematically resize all of the DU's in a given assembly that match the given tag to the given size.

Options

• ==max takes a positive integer argument value to indicate the maximum number of resizes that should be allowed in parallel (default=1). A --max=1 argument means resize them all sequentially.

Examples:

assembly resize --max=2 my_app_01 my_app_tier large
assembly resize my_app_02 my_app_tier medium

Solum-R1.11 assembly delete: CLI

Synopsis: assembly delete <assembly_name> Delete the given Assembly by name.

Solum-R1.12 app create: CLI

Synopsis: app create [--plan=plan_file] [--image=image_id] [--repo=repo_uri] [--build=no] [--run=yes] <plan_name>
Create a Plan with a given image (Deployment Artifact) and/or Plan file. Return the name of the Plan created.

Options:

• If --plan=plan_file is supplied, use the specified plan file to initialize the plan resource in Solum.
• If --image=image_id is supplied, use it as a glance image that has been pre-built.
• If --repo=repo_uri is supplied with --plan=plan_file, any plan file in the repo will be ignored, and the one specified on the CLI will be used instead.
• If --repo=repo_uri is suppied, the system will look for solum.yaml in the repsitory root to use as the planfile. If solum.yaml is not present, it will look for solum.yaml.
• If --build=no is supplied (default=yes), do not trigger a build.
  • Note: --build requires --planfile.
• If --run=yes is specified (default=no) an assembly will be automatically created. The name will be auto-generated based on the name of the plan, with an underscore and a numeric value so that each assembly name is unique (Example: my_app_02).

Solum-R1.13 app deploy: CLI

Synopsis: app deploy [--repo=repo_uri] [--image=image_id] [--template=hot_file] <assembly_name>

Create an Assembly from a given Plan. Return the name of the assembly created.

Options:

• If the --repo is supplied, it will create the plan and the assembly.
• If the --image=image_id (image_id=glance image id) is supplied, then no build is triggered, and the given image is used in the created assembly.
• If --template=hot_file is supplied, use the supplied HOT instead of generating one.

Examples:

app deploy --repo=https://github.com/racker/statsd my_statsd_app
app deploy --image=8490543-54483905-548395840-458943 my_statsd_app_01
app deploy --image=8490543-54483905-548395840-458943 --template=statds.hot my_statsd_app_02

Solum-R1.14 app scale: CLI

Alias for assembly scale

Solum-R1.15 app delete: CLI

Synopsis: app delete [--force] <plan_name>

Delete an Plan, andoptionally its related Assemblies.

Options

• If --force is supplied, also delete all related Assemblies.

Solum-R1.16 REST API

REST API for Solum suitable for use by a CLI client, IDE plugins, Git integration scripts, etc.