Creating Services
$ shipa service create path/to/manifest [- for stdin]
Creates a service based on a manifest file. The file format should be YAML and follow the standard described in the documentation.
Destroying Services
$ shipa service destroy <servicename>
The command above removes a service from catalog.
Flags:
Flag | Description |
---|---|
-y, --assume-yes | (= false) Don't ask for confirmation. |
Updating Services
$ shipa service update <path/to/manifest>
Updates service data extracting it from the given manifest file.
Generating Template Files
$ shipa service template
The command above generates a manifest template file and places it in the current directory
Listing Services
The command below retrieves and shows a list of services the user has access to. If there are instances created for any service, they will also be shown.
$ shipa service-list
Adding Documentation to Services
$ shipa service doc add <service> <path/to/docfile>
Update service documentation, extracting it from the given file.
Verifying Service Documentation
$ shipa service doc get <service>
The command above shows service documentation.
Displaying Service Information
$ shipa service info <service-name>
Displays a list of all instances of a given service (that the user has access to) and applications bound to these instances.
Creating Service Instances
$ shipa service instance add <service-name> <service-instance-name> [plan] [-t/--team-owner team] [-d/--description description] [-g/--tag tag]... [--plan-param key=value]
The command above creates a service instance of a service. These can later be bound to applications with Shipa's service bind command.
The example below demonstrate how to add a new instance of MongoDB service, named shipa_mongodb with the plan small:
$ shipa service instance add mongodb shipa_mongodb small -t myteam
Flags:
Flag | Description |
---|---|
-d, --description | (= "") service instance description |
-g, --tag | (= []) service instance tag |
--plan-param | (= {}) Plan specific parameters |
-t, --team-owner | (= "") the team that owns the service (mandatory if the user is member of more than one team) |
Updating Service Instances
$ shipa service instance update <service-name> <service-instance-name> [-t/--team-owner team] [-d/--description description] [-p/--plan plan] [-g/--tag tag]
The command above updates a service instance.
-
--team-owner: updates the team owner of a service instance.
-
--description: sets a description for the service instance.
-
--plan: updates the service instance plan.
-
--tag: adds a tag to the service instance. This parameter may be used multiple times.
Flags:
Flag | Description |
---|---|
-d, --description | (= "") service instance description |
-g, --tag | (= []) service instance tag |
-p, --plan | (= "") service instance plan |
-t, --team-owner | (= "") service instance team owner |
Removing Service Instance
$ shipa service instance remove <service-name> <service-instance-name> [-f/--force] [-y/--assume-yes]
Destroys a service instance. It can't remove a service instance bound to an application, so before removing a service instance, ensure there are no applications bound to it ( the service instance info command can be used).
Flags:
Flag | Description |
---|---|
-f, --force | (= false) Forces the removal of a service instance bound to applications |
-y, --assume-yes | (= false) Don't ask for confirmation |
Displaying Status
$ shipa service instance status <service-name> <service-instance-name>
The command above displays the given service instance's status, checking if the instance is up (receiving connections) or down (refusing connections).
Displaying Service Information
$ shipa service instance info <service-name> <instance-name>
Displays the information of a given service instance.
Binding Application to Services
$ shipa service instance bind <service-name> <service-instance-name> [-a/--app appname] [--no-restart]
Binds an application to a previously created service instance. Please check the service instance add command for more details on creating a service instance.
When binding an application to a service instance, Shipa will add new environment variables to the application. All environment variables exported by bind will be private (not accessible through the env get command).
Flags:
Flag | Description |
---|---|
-a, --app | (= "") The name of the application |
--no-restart | (= false) Binds an application to a service instance without restarting the application |
Unbind Application from Services
$ shipa service instance unbind <service-name> <service-instance-name> [-a/--app appname] [--no-restart] [--force]
Unbinds an application from a service instance. After unbinding, the instance will not be available anymore. For example, when unbinding an application from a MySQL service, the application loses access to the database.
Flags:
Flag | Description |
---|---|
-a, --app | (= "") The name of the application |
--force | (= false) Forces the unbind even if the unbind API call to the service fails |
--no-restart | (= false) Unbinds an application from a service instance without restart the application |
Team Access to Service Instance
$ shipa service instance grant <service-name> <service-instance-name> <team-name>
Grants access to a team in a service instance.
Revoking Access to Service Instances
$ shipa service instance revoke <service-name> <service-instance-name> <team-name>
Revokes access to the team in a service instance.
Updated about a month ago