supported-cf-cli-commands.md

cf CLI commands supported by Application Service Adapter

In this topic, you can learn about the Cloud Foundry command-line interface (cf CLI) commands and options that are supported by Application Service Adapter.

Application Service Adapter supports the following cf CLI commands by providing a subset of the endpoints of the v3 Cloud Foundry API (CAPI) through its API server. For more information, see the Cloud Foundry documentation.

Only the listed commands are supported. Other commands might fail or behave incorrectly.

Getting started

Command	Supported?	Notes
cf login	Y	Using the --sso flag is not supported.
cf logout	Y	n/a
cf target	Y	n/a
cf passwd	N	n/a
cf api	Y	n/a
cf auth	Y	Use the name of a user authentication information entry from the local Kubeconfig file as the username argument. The password field is ignored.

The cf push command

Application Service Adapter supports the basic use of cf push APP-NAME, where APP-NAME is the name of your app.

Flag	Supported?	Notes
--app-start-timeout, -t	Y	n/a
--buildpack, -b	Y	For automatic buildpack detection, omit the flag or set to null or default
--disk, -k	Y	n/a
--docker-image, -o	Y	n/a
--docker-username	Y	n/a
--droplet	N	n/a
--endpoint	N	n/a
--health-check-type, -u	Y	n/a
--instances, -i	Y	n/a
--manifest, -f	Y	Some manifest configurations described in App Manifest Attribute Reference are supported. See the Supported manifest configuration section.
--memory, -m	Y	n/a
--no-manifest	Y	n/a
--no-route	Y	n/a
--no-start	Y	n/a
--no-wait	N	n/a
--path, -p	Y	n/a
--random-route	Y	n/a
--stack, -s	N	n/a
--start-command, -c	Y	n/a
--strategy	N	n/a
--task	Y	n/a
--var	Y	n/a
--vars-file	Y	n/a

Supported manifest configuration

The Application Service Adapter supports a subset of the Cloud Foundry manifest schema. For more information, see The manifest schema in the CAPI documentation.

Supported app-level configuration

Attribute	Supported?	Notes
buildpacks	Y	n/a
command	Y	n/a
default-route	Y	n/a
disk_quota	Y	n/a
docker	Y	n/a
env	Y	n/a
health-check-http-endpoint	Y	n/a
health-check-invocation-timeout	Y	n/a
health-check-type	N	n/a
instances	Y	n/a
memory	Y	n/a
metadata	N	n/a
no-route	Y	n/a
path	N	n/a
processes	Y	See the Supported process-level configuration section.
random-route	Y	n/a
routes	Y	See the Supported route-level configuration section.
services	N	n/a
sidecars	N	n/a
stack	N	n/a
timeout	Y	n/a

Supported process-level configuration

Attribute	Supported?	Notes
type	Y	n/a
command	Y	n/a
disk_quota	Y	n/a
health-check-http-endpoint	Y	n/a
health-check-invocation-timeout	Y	n/a
health-check-type	Y	n/a
instances	Y	n/a
memory	Y	n/a
timeout	Y	n/a

Supported route-level configuration

Attribute	Supported?	Notes
route	Y	n/a
protocol	N	Only http1 routes are supported.

App operations

Command	Supported?	Notes
cf apps	Y	The default usage of cf apps is supported. Using --labels to filter apps is not supported.
cf app	Y	n/a
cf create-app	Y	n/a
cf scale	Y	n/a
cf delete	Y	n/a
cf rename	N	n/a
cf cancel-deployment	N	n/a
cf start	Y	n/a
cf stop	Y	n/a
cf restart	Y	n/a
cf stage-package	Y	n/a
cf restage	Y	Using --strategy flag is not supported.
cf restart-app-instance	N	n/a
cf run-task	Y	Only the -c parameter is supported.
cf tasks	Y	n/a
cf terminate-task	Y	n/a
cf packages	Y	n/a
cf create-package	Y	n/a
cf droplets	N	n/a
cf set-droplet	Y	n/a
cf download-droplet	N	n/a
cf events	N	n/a
cf logs	Y	n/a
cf env	Y	Fetching system-provided, running, and staging environment variables are not supported.
cf set-env	Y	n/a
cf unset-env	Y	n/a
cf stacks	N	n/a
cf stack	N	n/a
cf copy-source	N	n/a
cf create-app-manifest	N	n/a
cf get-health-check	Y	n/a
cf set-health-check	Y	n/a
cf enable-ssh	N	n/a
cf disable-ssh	N	n/a
cf ssh-enabled	N	n/a
cf ssh	N	n/a

Org and space operations

This section describes the org and space operations that Application Service Adapter supports.

Org operations

Command	Supported?	Notes
cf orgs	Y	n/a
cf org	Y	Using the --guid flag to retrieve the GUID of the org is supported. Using the command without the --guid flag is not supported.
cf create-org	Y	n/a
cf delete-org	Y	n/a
cf rename-org	N	n/a
cf set-org-role	Y	n/a
cf unset-org-role	Y	n/a

Space operations

Command	Supported?	Notes
cf spaces	Y	n/a
cf space	Y	Using the --guid flag to retrieve the GUID of the space is supported. Using the command without the --guid flag is not supported.
cf create-space	Y	n/a
cf delete-space	Y	n/a
cf rename-space	N	n/a
cf apply-manifest	Y	n/a
cf allow-space-ssh	N	n/a
cf disallow-space-ssh	N	n/a
cf space-ssh-allowed	N	n/a
cf set-space-role	Y	n/a
cf unset-space-role	Y	n/a

Route and domain operations

This section describes the route and domain operations that Application Service Adapter supports.

Route operations

Command	Supported?	Notes
cf routes	Y	n/a
cf route	Y	n/a
cf create-route	Y	n/a
cf check-route	N	n/a
cf map-route	Y	n/a
cf unmap-route	Y	n/a
cf delete-route	Y	n/a
cf delete-orphaned-routes	N	n/a

Domain operations

Command	Supported?	Notes
cf domains	Y	n/a
cf create-private-domain	N	n/a
cf delete-private-domain	N	n/a
cf create-shared-domain	N	n/a
cf delete-shared-domain	N	n/a
cf router-groups	N	n/a

Service operations

This section describes the service operations that Application Service Adapter supports.

Command	Supported?	Notes
cf marketplace	N	n/a
cf services	Y	n/a
cf service	Y	n/a
cf create-service	N	n/a
cf update-service	N	n/a
cf upgrade-service	N	n/a
cf delete-service	Y	n/a
cf rename-service	N	n/a
cf create-service-key	N	n/a
cf bind-service	Y	n/a
cf unbind-service	Y	n/a
cf delete-service-key	N	n/a
cf bind-route-service	N	n/a
cf unbind-route-service	N	n/a
cf create-user-provided-service	Y	n/a
cf update-user-provided-service	N	n/a
cf share-service	N	n/a
cf unshare-service	N	n/a

Metadata operations

This section describes the metadata operations that Application Service Adapter supports.

Command	Supported?	Notes
cf labels	Y	The app, org, and space resources are supported.
cf set-label	Y	The app, org, and space resources are supported.
cf unset-label	Y	The app, org, and space resources are supported.

User role management

This section describes the operations for adding and removing roles that Application Service Adapter supports. These commands work for both Kubernetes users and Kubernetes service accounts. When assigning roles to Kubernetes service accounts, specify the user name in the format system:serviceaccount:<ServiceAccountNamespace>:<ServiceAccountName>, with <ServiceAccountNamespace> and <ServiceAccountName> replaced with the actual values.

Command	Supported?	Notes
cf set-org-role	N	The command succeeds, but there are no supported org roles.
cf unset-org-role	N	The command succeeds, but there are no supported org roles.
cf set-space-role	Y	Supported roles: SpaceDeveloper
cf unset-space-role	Y	Supported roles: SpaceDeveloper