Using vcapFile to create/update cf user-provided service

Open
#53 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
node.js
Domain
cloud

Research direction

Start by comparing the vcap-local-env.json structure with the payload expected by cf update-user-provided-service -p. Review how cfenv.getAppEnv({ vcap: localVCAP }) consumes the file, then document a recommended way to share and update credentials without interactive entry. Done means the guidance covers both local reads and Cloud Foundry service updates.

Written by the indexing model from the issue text.

Description

Hi,

I'm using cfenv to handle my credentials. I setup a cf user-provided service within cf and added a local vcapFile for running the app locally.

This is how I read the credentials (locally and prod)

// read envs from file if running locally =========================
let localVCAP = null;
try {
  localVCAP = require('./vcap-local-env.json');
} catch (error) {
  // silently ignoring failure when running inside cloudfoundry
}

// include environment variables from vcap service
const appEnv = cfenv.getAppEnv({ vcap: localVCAP });
const cfEnv = appEnv.getService('credential-service-test-app').credentials;

That all works fine, the only issue I see is when updating the user-provided service. In order to be able to use the same code for reading the envs, my vcapFile looks like this:

{
    "application": {
        "port": 4002
    },
    "services": {
        "credential-service-test-app": [
            {
                "credential-service-test-app",
                "credentials": {
                    "SECRET_PWD":"<***>",
                  
                }
            }
        ]
    }
}

But this way I'm not able to use the file for updating the service with cf update-user-provided-service credential-service-test-app -p ./vcap-local-env.json, since it will nest the application/services within the cf services object.

I don't want to use the interactive cf update-user-provided-service credential-service-test-app -p command every time a change a parameter and having to add all params again.

What would be the recommend way of maintaining the user-provided service amongst several coders?

Dominant language
CoffeeScript
Stars
74
Forks
25
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cloudfoundry-community/node-cfenv

All issues in cloudfoundry-community/node-cfenv

Similar issues

More Cloud issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.