Using the Bluemix CLI IBM Corporation

Transcription

1 Using the Bluemix CLI

2 After you complete this section, you should understand: How to use the bx Bluemix command-line interface (CLI) to manage applications bx commands help you do tasks such as: Log in to Bluemix Push applications Manage services Work with application logs, domains and routes 2

3 IBM Auto- Scaling plugin Container Service plugin Container image registry plugin Bluemix command-line interface Bluemix CLI: A modular command interface that extends Cloud Foundry CLI subcommand provides... app service Manage cf apps, app domains, routes, and certificates Manage Bluemix and user-provided services iam Manage accounts, orgs, spaces and API keys plugin Manage plugins for Bluemix CLI Bluemix- bx Cloud Foundry - cf <plugin name> cf Manage features enabled by the plugin Run provided cf command using current bx session (login, org, space) context ex: scale Use at a terminal to manage apps or in scripts for CI/CD automation 3

4 Log in to Bluemix Usage bx login [-a API_URL] [--apikey ] [--sso] [-u USERNAME] [-p PASSWORD] [-o ORG] [-s SPACE] Arguments API endpoint: This is the URL of the Cloud Controller in your Cloud Foundry instance API key: Alternative to user name, password, and org SSO flag: Needed when using an enterprise ID federated with IBMid Username: Your user name, such as your Bluemix ID Password: Your password. Org: The organization where you want to deploy your application. Space: The space in the organization where you want to deploy your application. Example : bx login a u developer@us.ibm.com -p XXXX o developer@us.ibm.com -s dev 4

5 Most common Bluemix Cloud Foundry app commands Push application in the current directory to Bluemix, deploy and start the application bluemix app push List all applications in the current org and space bluemix app list Show health and status of all instances of a specific app bluemix app show APP_NAME Show all environment variables associated with a specific app bluemix app env APP_NAME Show current log stream for a specific app. The --recent flag selects history from buffer bluemix app logs APP_NAME[--recent] Application start, stop, and delete bluemix app start APP_NAME bluemix app stop APP_NAME bluemix app delete APP_NAME 5

6 Common Bluemix managed service-related commands Provide a list of all catalog services in the marketplace for the logged in user, region, and acct bluemix service offerings List all provisioned services in the current org and space bluemix service list Create a service in the current org and space of a specific type, plan, and desired name bluemix service create SERVICE PLAN SERVICE_INSTANCE_NAME Bind a provisioned service in the space to a specific app bluemix service bind APP_NAME SERVICE_INSTANCE_NAME Remove the service from the space bluemix service delete Manage keys (credentials) for a service bluemix service key-create SERVICE_INSTANCE_NAME SERVICE_KEY bluemix service key-show SERVICE_INSTANCE_NAME SERVICE_KEY bluemix service key-delete SERVICE_INSTANCE_NAME SERVICE_KEY 6

7 Push an application to Bluemix Usage bx app push APP [-b URL] [-c COMMAND] [-d DOMAIN] [-i NUM_INSTANCES] [-m MEMORY] [-n HOST] [-p PATH] [-s STACK] [--no-hostname] [--no-route] [--no-start] 7 Arguments -b Custom buildpack by name or GIT URL, for example, sdk-for-nodejs or -c Start command for the application. -d Domain, for example, example.com. -f replaces --manifest -i Number of instances of the application to run. -m Memory limit, for example, 256, 1G, 1024M, and so on. -n Hostname, for example, my-subdomain. -p Path to application directory or archive. -s Stack to use. -t Timeout to start in seconds, give your application more time to start, up to 180 secs. --no-hostname Map the root domain to this application --no-manifest Ignore manifests if they exist. --no-route Do not map a route to this application. --no-start Do not start the application after pushing. Example: bx app push my-app -c node my-app.js

8 Scale a running application with CLI commands Use the bx app scale command to scale your application up or down horizontally and vertically Scaling horizontally bx app scale APP -i INSTANCES to horizontally scale your application Cloud Foundry will increase or decrease the number of instances of your application to match INSTANCES Example: bx app scale myapp i 5 Scale vertically Vertically scaling an application changes the memory limit or disk space that Cloud Foundry applies to all instances of the application Change memory limit: bx app scale APP m MEMORY MEMORY must be an integer followed by either an M, for megabytes, or G, for gigabytes. Example: bx app scale myapp -m 512M or bx app scale myapp -m 1G 8

9 Application Loggregator Application logging subsystem of Cloud Foundry Assembles stdout/stderr from app and also environment components Loggregator allows users to: Tail application logs Dump a recent set of application logs from the buffer with --recent Continually drain their application logs to third-party log archive and analysis services Usage: bx app logs APP_NAME [--recent] 9

10 Manage Domains and Routes for applications All domains are mapped to an Organization Domains can be shared or private. Shared domains are registered to multiple orgs while private domains, or owned domains, are registered to one org. To list domains in the target organization: bx app domains Commands for managing domains: bx app domain-create Create a domain. bx app domain-delete Delete a domain. bx app domain domain-cert-add Add an ssl certificate to a domain Commands for managing routes: bx app route-create Create a route, takes form HOSTNAME.DOMAIN bx app route-map Map a route to an application. If the route does not exist, this command creates it and then maps it. bx route-unmap Remove a route from an application. bx route-delete Delete a route.

11 Related links IBM Bluemix documentation: Getting Started with the bx CLI IBM Bluemix documentation: Bluemix overview IBM Bluemix documentation: Services IBM Bluemix documentation: "Regions and API endpoints: 11