Cloud Foundry CLI

Installation

Install CLI (Command Line Interface) for SAP BTP Cloud Foundry https://tools.hana.ondemand.com/#cloud

Add below plugins to support "cf deploy" for SAP BTP CF

cf install-plugin -r CF-Community "multiapps"

SAP Help Portal | SAP Online Helphelp.sap.com

Cloud Foundry CLI Quick Reference Guide

Welcome to the Cloud Foundry Command Line Interface (CLI) Quick Reference Guide. This document provides an overview of essential commands and their usage to help you efficiently navigate Cloud Foundry and manage your applications and services. Whether you're deploying applications, checking logs, working with services, scaling resources, or performing administrative tasks, this guide has got you covered.

Table of Contents

1. Login to Cloud Foundry

2. Working with Services

3. Administrative Commands

4. Working with Applications

5. Additional Commands

---

1. Login to Cloud Foundry

Use the cf login command to log in to Cloud Foundry.

$ cf login -a API_URL -u USERNAME -o ORG -s SPACE

• -a: Cloud Foundry API URL

• -u: Your username

• -o: Target organization

• -s: Target space

Alternatively, you can use SSO to login Cloud Foundry:

cf login --sso

---

2. Working with Services

List Marketplace Services

Explore available services from the marketplace.

$ cf marketplace

Manage Services

$ cf service

---

3. Administrative Commands

Make sure that you are in the Cloud Foundry organization you want to add a space to.

$ cf target -o ORG

Set Organization Role

Specify the user name, organization name, and the role to add.

$ cf set-org-role <USERNAME> <ORG> <ROLE>

Remove Organization Role

To remove an org role from a user, specify the user name, organization name, and the role.

$ cf unset-org-role <USERNAME> <ORG> <ROLE>

Set Space Role

Specify the user name, organization name, space name, and the role to add.

$ cf set-space-role USERNAME ORG SPACE ROLE

Remove Space Role

To remove a space role from a user, specify the user name, organization name, space name, and the role.

$ cf unset-space-role USERNAME ORG SPACE ROLE

Create Space Quota

Create a space quota plan by specifying the name, memory limits, route limits, service instance limits, and service plan allowance.

$ cf create-space-quota QUOTA [-i INSTANCE_MEMORY] [-m MEMORY] [-r ROUTES] [-s SERVICE_INSTANCES] [--allow-paid-service-plan | --disallow-paid-service-plans]

• -i: Maximum amount of memory an application instance can have (-1 represents an unlimited amount).

• -m: Total amount of memory a space can have.

• -r: Total number of routes.

• -s: Total number of service instances.

• --allow-paid-service-plans: Can provision instances of paid service plans.

• --disallow-paid-service-plans: Cannot provision instances of paid service plans.

Assign Quota Plans to Spaces

Assign a space quota plan to a specific space.

$ cf set-space-quota SPACE_NAME SPACE_QUOTA_NAME

Change Space Quota Plans

Update an existing space quota plan with new settings.

$ cf space-quotas
$ cf update-space-quota SPACE-QUOTA-NAME [-i MAX-INSTANCE-MEMORY] [-m MEMORY] [-n NEW_NAME] [-r ROUTES] [-s SERVICES] [--allow-paid-service-plans | --disallow-paid-service-plans]

Delete Spaces

Delete a space in Cloud Foundry.

$ cf delete-space SPACE [-o ORG] [-f]

---

4. Working with Applications

List Apps

Use cf apps to list all applications in the target space.

$ cf apps

Start, Stop, and Restart Apps

Control the state of an application using these commands:

• Start an app:

$ cf start <app-name>

• Stop an app:

$ cf stop <app-name>

• Restart an app:

$ cf restart <app-name>

View App Logs

Check recent logs for an application using the cf logs command.

$ cf logs <app-name> --recent

Check App Health and Status

Determine the health and status of an application with the cf app command.

$ cf app <app-name>

Scaling Apps

Scale the number of instances, memory, or disk for an application.

• Scale the number of instances:

$ cf scale <app-name> -i INSTANCES

• Scale memory limit:

$ cf scale <app-name> -m MEMORY_LIMIT

• Scale disk limit:

$ cf scale <app-name> -k DISK_LIMIT

Delete Apps

Remove an application using the cf delete command.

$ cf delete <app-name> -f

---

5. Additional Commands

List Buildpacks

Discover available application buildpacks using the cf buildpacks command.

$ cf buildpacks

List MTAs and HTML5 Apps

$ cf mtas
$ cf html5-list

List Installed Plugins

Explore installed Cloud Foundry CLI plugins.

$ cf plugins

Remember, the Cloud Foundry CLI provides powerful tools to manage applications and services within your Cloud Foundry environment. With this quick reference guide, you'll be well-equipped to perform common tasks and streamline your workflow.