A web UI for interacting with GOV.UK PaaS (CloudFoundry).
It aims to be a progressive enhanced, well tested and user researched tool that tenants can use to complement their use of the CLI.
npm run build # compile the build to ./dist
npm run test # run all the tests and linters
npm run test:unit # only unit tests
npm run lint # run code linters
npm run fix # try to autofix problems with js/css
npm run start # rebuild and start the server
npm run push # rebuild and push to cloudfoundry
npm run clean # destroy the ./dist build dirYou will need to add a UAA client to your CloudFoundry deployment manifest, for example:
paas-admin:
override: true
authorized-grant-types: authorization_code,client_credentials,refresh_token
autoapprove: true
secret: [CF_CLIENT_SECRET]
scope: cloud_controller.read,cloud_controller.admin_read_only,cloud_controller.global_auditor,cloud_controller.write,scim.me,openid,profile,uaa.user,cloud_controller.admincloud_controller.read,cloud_controller.admin_read_only,cloud_controller.global_auditor,cloud_controller.write,scim.me,openid,profile,uaa.user,cloud_controller.admin
authorities: scim.userids,scim.invite,scim.read
redirect-uri: "https://[pass-admin-domain.com]/auth/login/callback"If you get problems with "Invalid redirect", use uaac to modify the redirect-uri:
uaac target https://uaa.my.environment
uaac token client get admin -s my-uaa-admin-client-secret
uaac client update paas-admin --redirect-uri http://localhost:3000/auth/login/callback
- Node.js version
~ 14LTS - consider using NVM (nvm usein this repo) for version management - npm versions
> 7.x.x
Clone this repository and then use npm to install the project dependencies:
npm installExecute the unit tests to ensure everything looks good:
npm testExecuting the acceptance tests against dev environment:
export PAAS_ADMIN_BASE_URL=https://admin.${DEPLOY_ENV}.dev.cloudpipeline.digital
export CF_API_BASE_URL=https://api.${DEPLOY_ENV}.dev.cloudpipeline.digital
export ACCOUNTS_API_BASE_URL=https://accounts.${DEPLOY_ENV}.dev.cloudpipeline.digital
export ACCOUNTS_USERNAME=admin
export ACCOUNTS_PASSWORD= # get this value from credhub using `credhub get -n /concourse/main/create-cloudfoundry/paas_accounts_password`
export ADMIN_USERNAME=admin
export ADMIN_PASSWORD= # get this value from credhub using `credhub get -n /${DEPLOY_ENV}/${DEPLOY_ENV}/cf_admin_password`
npm run test:acceptance# In one terminal tab
npm run start:stub-api
# In a second terminal tab
npm run start:with-stub-apiRun
gds aws paas-dev-admin -- npm run start:dev:with-cf-dev-env $DEPLOY_ENVand follow on-screen instructions.
You should be able to edit files in the ./src directory and the changes will
automatically be updated.
Provided you have logged in CF and have AWS credentials
- Update uaa user:
DEPLOY_ENV=...
uaac target https://uaa.${DEPLOY_ENV}.dev.cloudpipeline.digital
uaac token client get admin -s $(aws s3 cp s3://gds-paas-${DEPLOY_ENV}-state/cf-vars-store.yml - | grep uaa_admin_client_secret | cut -f2 -d " ")
uaac client update paas-admin --redirect-uri http://localhost:3000/auth/login/callback
- Get the command to start the server:
cf target -o admin -s public
cf env paas-admin | awk '/User-Provided/ { printing=1; next} /^$/ { printing=0 ; next} printing {gsub(": ","=\""); gsub("$", "\" \\"); print; next } END { print "npm start"}'
- Undo the paas-admin client change once done:
uaac client update paas-admin --redirect-uri https://admin.${DEPLOY_ENV}.dev.cloudpipeline.digital/auth/login/callback
The NODE_ENV environment variable alters the build process to bundle all
dependencies into the ./dist/ directory.
NODE_ENV=production npm run build
The ./dist folder should now be a distributable without the need for the
node_modules folder and should be executable on any environment that has a
supported version of Node.js, e.g., cf push.
To push the build to CloudFoundry there is a helper script that creates a
production build and calls cf push:
npm run pushThis project is fairly young and may not be a right fit for different needs yet.
You may be interested in investigating other tools, such as Stratos which may become an official tool some day.
![dependabot-preview[bot] avatar](https://avatars.githubusercontent.com/in/2141?v=4 "dependabot-preview[bot]")
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent