Skip to content

Cloud Foundry How-Tos

This section describe common activities for managing your Cloud Foundry environment. This collection does only cover some aspects of Cloud Foundry and are not intended to replace the official documentation.

Add a new user

After the initial account registration the Tenant Owner will be assigned the Org Manager role within his tenants Cloud Foundry Org. He can then assign roles to new users via the Cloud Foundry CLI.

Attention

Prerequisites for adding a new user:

Info

The tenant role and the Cloud Foundry role are not the same and need to be assigned separately.

Change role for a user

Users can have one or more roles. The combination of these roles defines the user's overall permissions in the Org and within specific app spaces in that Org.

Use the following commands for managing users on an Org level.

Function Command Example
View the organizations belonging to an account cf orgs cf orgs
View all users in an organization by role cf org-users ORGANIZATION-NAME cf org-users my-mindsphere-org
Assign an Org role to a user cf set-org-role USERNAME ORGANIZATION-NAME ROLE cf set-org-role Alice my-mindsphere-org OrgManager
Remove an Org role from a user cf unset-org-role USERNAME ORGANIZATION-NAME ROLE cf unset-org-role Alice my-mindsphere-org OrgManager

And these for only assigning access to specific spaces.

Function Command Example
View the spaces in an Org cf spaces cf spaces
View all users in a space by role cf space-users ORGANIZATION-NAME SPACE-NAME cf space-users my-mindsphere-org development
Assign a space role to a user cf set-space-role USERNAME ORGANIZATION-NAME SPACE-NAME ROLE cf set-space-role Alice my-example-org development SpaceAuditor
Remove a space role from a user cf unset-space-role USERNAME ORGANIZATION-NAME SPACE-NAME ROLE cf unset-space-role Alice my-mindsphere-org development SpaceAuditor

Add a new space

Use cf create-space SPACE to create a new space within your Org. Next, you can proceed and assign one of your developers the SpaceManager or SpaceDeveloper role by using cf set-space-role USERNAME ORG SPACE ROLE. You can list all users of an space with cf space-users.

Assign a user to an space

Use cf set-space-role USERNAME ORG SPACE ROLE to add a user to a space.

Create a service instance

MindSphere provides multiple backing services out of the box that can be used for application development and operation. These services are managed and will be provisioned on a dedicated VM. Depending on your Org quota and settings you can create multiple service instances. Each instance is related to a backing service plan that describes the hardware, capabilities and the number of instances (e.g. clustered instances).

Service instances are always tied to a specific space and cannot be used across multiple spaces. This is a design choice of Cloud Foundry to ensure isolated sub-environments. Use cf marketplace or cf m to list all available Backing Services and their associated plans. Choose your desired service and create a new instance with cf create-service SERVICE PLAN SERVICE_INSTANCE. As a next step you can bind this service to one of your apps.

Use cf service SERVICE_INSTANCE to get detailed information about your service instance.

Bind a service instance

Bind the service with cf bind-service my-app myservice to one of your apps running in the same space as the service. After the binding the service credentials are available as environment variables and can be used within your application.

Backup & Restores service instances

You can use the service URL to visit the Backing Service Dashboard and start backups and restore an older one.

Background Tasks / Processes

Cloud Foundry also allows to run background processes that for example data crunching. Those background processes are normal Cloud Foundry apps, but without a route. Therefore, it is necessary to use the --no-route parameter for pushing applications or set this as a attribute in your manifest.yml.

Warning

If you forget to disable the route, Cloud Foundry is going to perform periodically health checks that will fail. Due to this failing health checks the Cloud Controller is going to stop your application.

Please refer to the official documentation for further details:

How can I find my current usage of my Org

Use the cf org ORG command to get information about your Org.

Create a User-Provided-Service

Please feel read the official Cloud Foundry documentation on how to create and use these.

Warning

Heads up! Only use this feature if you are aware about the security and operational consequences of this feature. Consider using restrictive firewall settings or set up a peering connection!

Any questions left?

Ask the community


Except where otherwise noted, content on this site is licensed under the MindSphere Development License Agreement.