This repository has been archived by the owner on Nov 30, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 180
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc(applications): deploying add-ons
- Loading branch information
Matthew Fisher
committed
Apr 11, 2017
1 parent
1326ba7
commit 9b6d484
Showing
3 changed files
with
107 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
# Deploying Add-ons | ||
|
||
The goal of `deis addons` is to give users the power to provision consumable services such as | ||
a postgres database, a minio bucket, or a logstash connection) to their applications. `deis addons` | ||
can work with both common on-premise services such as a local mysql database or a Redis server | ||
for a "private" or on-premise service registry, or with public SaaS applications such as MongoLab | ||
or Papertrail for a public service offering. | ||
|
||
`deis addons` is backed by a project called [service-catalog][]. Service-catalog brings integration | ||
with [service brokers][] to the Kubernetes ecosystem via the [Open Service Broker API][]. | ||
|
||
Users of Workflow use `deis addons` to provision an add-on offered by [service brokers][] for | ||
their applications. The end-goal is to provide a way for users to consume services from brokers and | ||
have their applications use those services without needing detailed knowledge about how those | ||
services are created or managed. | ||
|
||
As an example, most applications deployed by Workflow need a data store of some kind. `deis addons` | ||
allows applications to consume services like databases that exist somewhere via common environment | ||
variables like `DATABASE_URL`. | ||
|
||
## Listing Available Add-ons | ||
|
||
A user can use `deis addons:installed` to see if they have a database provisioned and what plan it | ||
is using. | ||
|
||
``` | ||
$ deis addons:installed | grep -i postgresql | ||
$ deis-postgresql:standard | ||
``` | ||
|
||
If the application doesn’t yet have a database provisioned, a user can create a new database using | ||
the CLI. | ||
|
||
If a user wishes to see all available addons, they can use `deis addons:list`. | ||
|
||
``` | ||
$ deis addons:list | ||
slug name | ||
--------------- ---------------------- | ||
bonsai Bonsai Elasticsearch | ||
deis-postgresql Deis Workflow Postgres | ||
librato Librato | ||
``` | ||
|
||
## Provisioning the Add-on | ||
|
||
Most service brokers offers a variety of plans, usually spread across different tiers of service: | ||
hobby, standard, premium, and enterprise. For a detailed breakdown on the available plans, check | ||
the documentation for the applicable service broker to help choose the right service tier for the | ||
application. | ||
|
||
For example, to provision a `standard` plan database: | ||
|
||
``` | ||
$ deis addons:create deis-postgresql:standard --app wooden-rowboat | ||
Creating deis-postgresql:standard... done | ||
Attaching deis-postgresql:standard to wooden-rowboat... done, v5 | ||
``` | ||
|
||
Depending on the plan, some services can take some time before it becomes available for use. Use | ||
`deis addons:wait` to wait for the service to become available. | ||
|
||
Once the service has been attached to the application, a DATABASE_URL setting will be available in | ||
the application's configuration and will contain the URL used to access the newly provisioned | ||
service. | ||
|
||
## Deprovisioning the Add-on | ||
|
||
To deprovision a `standard` plan database: | ||
|
||
``` | ||
$ deis addons:destroy deis-postgresql:standard | ||
Destroying deis-postgresql:standard... done | ||
``` | ||
|
||
## Attaching the Add-on | ||
|
||
Once the add-on is provisioned, it is bound to the user's account and can be bound to any number of | ||
applications the user has permissions to use. | ||
|
||
To attach an add-on to a new or existing application: | ||
|
||
``` | ||
$ deis addons:attach deis-postgresql:standard --app wooden-rowboat | ||
Attaching deis-postgresql:standard to wooden-rowboat... done, v5 | ||
``` | ||
|
||
## Detaching the Add-on | ||
|
||
Similarly, an add-on can be unbound from an application, but still be available to the user for | ||
future binding to another application. | ||
|
||
``` | ||
$ deis addons:detach deis-postgresql:standard --app wooden-rowboat | ||
Detaching deis-postgresql:standard from wooden-rowboat... done, v6 | ||
``` | ||
|
||
|
||
[Open Service Broker API]: https://github.com/openservicebrokerapi/servicebroker | ||
[service-catalog]: https://github.com/kubernetes-incubator/service-catalog | ||
[service brokers]: ../reference-guide/terms.md#service-broker |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters