Managing Service Instances

See below for information about managing Config Server service instances using the Cloud Foundry Command Line Interface tool (cf CLI). You can also manage Config Server service instances using Pivotal Web Services Apps Manager.

Creating an Instance

Begin by targeting the correct org and space.

$ cf target -o myorg -s development

You can view plan details for the Config Server product using cf marketplace -s.

$ cf marketplace -s p-config-server
Getting service plan information for service p-config-server as user...
OK

service plan   description     free or paid
standard       Standard Plan   free

Create the service instance using cf create-service, using the -c flag to provide a JSON object that specifies the configuration parameters. For information about the parameters used to configure a Git configuration source, see Configuring with Git. For information about the parameters used to configure a HashiCorp Vault configuration source, see Configuring with Vault.

General parameters accepted for the Config Server are listed below.

Parameter Function Example
count The number of nodes to provision: 1 by default, more for running in high-availability mode '{"count": 3}'

To create an instance, specifying settings for Git configuration sources and that three nodes should be provisioned:

$ cf create-service -c '{"git": { "uri": "https://github.com/spring-cloud-samples/config-repo", "repos": { "cook": { "pattern": "cook*", "uri": "https://github.com/spring-cloud-services-samples/cook-config" } } }, "count": 3 }' p-config-server standard config-server

You can use the cf services or cf service commands to check the status of the service instance. When the service instance is ready, the cf service command will give a status of create succeeded:

$ cf service config-server
Showing info of service config-server in org myorg / space development as user...

name:            config-server
service:         p-config-server
bound apps:
tags:

[...]

Showing status of last operation from service config-server...

status:    create succeeded

Important: The cf service and cf services commands may report a create succeeded status even if the Config Server cannot initialize using the provided settings. For example, given an invalid URI for a configuration source, the service instance may still be created and have a create succeeded status.

If the service instance does not appear to be functioning correctly, you can visit its dashboard to double-check that the provided settings are valid and accurate. See Using the Dashboard.

Updating an Instance

You can update settings on a Config Server service instance using the Cloud Foundry Command Line Interface tool (cf CLI). The cf update-service command can be given a -c flag with a JSON object containing parameters used to configure the service instance.

To update a Config Server service instance’s settings, target the org and space of the service instance:

$ cf target -o myorg -s development

Then run cf update-service SERVICE_NAME -c '{ "PARAMETER": "VALUE" }', where SERVICE_NAME is the name of the service instance, PARAMETER is a supported parameter, and VALUE is the value for the parameter. For information about the parameters used to configure a Git configuration source, see Configuring with Git. For information about the parameters used to configure a HashiCorp Vault configuration source, see Configuring with Vault.

General parameters accepted for the Config Server are listed below.

Parameter Function Example
count The number of nodes to provision: 1 by default, more for running in high-availability mode '{"count": 3}'
upgrade Whether to upgrade the instance '{"upgrade": true}'
force When upgrade is set to true, whether to force an upgrade of the instance, even if the instance is already at the latest available service version '{"force": true}'

To update a service instance, setting Git configuration sources, run:

$ cf update-service config-server -c '{"git": { "uri": "https://github.com/spring-cloud-samples/config-repo", "repos": { "cook": { "pattern": "cook*", "uri": "https://github.com/spring-cloud-services-samples/cook-config" } } } }'

To update a service instance and set the count of instances for running in high-availability mode, run:

$ cf update-service config-server -c '{"count": 3}'

You can use the cf services or cf service commands to check the status of the service instance. When the update is complete, the cf service command will give a status of update succeeded:

$ cf service config-server
Showing info of service config-server in org myorg / space development as admin...

name:            config-server
service:         p-config-server
bound apps:
tags:

[...]

Showing status of last operation from service config-server...

status:    update succeeded

Important: The cf service and cf services commands may report an update succeeded status even if the Config Server cannot initialize using the provided settings. For example, given an invalid URI for a configuration source, the service instance may still be restarted and have an update succeeded status.

If the service instance does not appear to be functioning correctly after an update, you can visit its dashboard to double-check that the provided settings are valid and accurate. See Using the Dashboard.

The service instance is now updated and ready to be used. For information about using an app to access configuration values served by a Config Server service instance, see Writing Client Applications.

Create a pull request or raise an issue on the source for this page in GitHub