Skip to content
This repository has been archived by the owner. It is now read-only.
Tools for Cloud Foundry administrators
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cf-cli-release
ci
packaging
scripts
.gitignore
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile

README.md

Traveling Cloud Foundry Admin CLIs

This project packages the CLIs used by Cloud Foundry administrators - the cf CLI and useful admin plugins, and the uaac CLI (a Ruby gem). They can be downloaded and used by anyone without requiring Ruby and native extensions.

Support for including useful admin plugins requires:

  • #332

And some people to start writing admin plugins... hint hint.

See below for the one-line installation instructions.

Dependencies

The goal of traveling-cf-admin is to have very few dependencies. curl is the only dependency for the simple installation process.

For Linux:

sudo apt-get update
sudo apt-get install curl -y

For OS X:

brew install curl

One user - simple installation

From any OS X or Linux terminal run the following command. It will download, unpack, and setup your $PATH:

curl -s https://raw.githubusercontent.com/cloudfoundry-community/traveling-cf-admin/master/scripts/installer | bash

All users - simple installation

From any OS X or Linux terminal run the following command. It will globally download, unpack, and setup your $PATH:

curl -s https://raw.githubusercontent.com/cloudfoundry-community/traveling-cf-admin/master/scripts/installer | sudo bash

Alternately see step-by-step instructions below.

Step-by-step installation

To download the latest release https://github.com/cloudfoundry-community/traveling-cf-admin/releases

For example:

rm -rf tar xfz cf-admin*.tar.gz
wget https://github.com/cloudfoundry-community/traveling-cf-admin/releases/download/v6.9.0.1/cf-admin-6.9.0.1-linux-x86_64.tar.gz
tar xfz cf-admin*.tar.gz
rm cf-admin*.tar.gz

Rewrite the internal shebangs of ruby-installed binaries:

./cf-admin*/helpers/rewrite-shebangs.sh

To check that cf and uaac are runnable:

./cf-admin-*/cf
./cf-admin-*/uaac

You could now create a symlink:

rm -f cf-admin
ln -s $PWD/$(ls -d cf-admin* | head -n1) cf-admin

Check that its runnable via the symlink:

To check that the CLIs are runnable:

./cf-admin/cf
./cf-admin/uaac

Finally, add the cf-admin path into your $PATH:

export PATH=$PATH:/path/to/cf-admin

Background

This project uses http://phusion.github.io/traveling-ruby/

Create & publish releases

Anyone in the @cloudfoundry-community can be responsible for create new releases whenever new CF CLI or UAAC versions are released. This section contains the instructions.

You are required to use Ruby 2.1 to create releases as this is what traveling-ruby uses.

You will also need to install https://github.com/aktau/github-release to share the releases on Github.

The release version number is directly taken from the CF CLI to be packaged.

To upgrade the uaac version (via cf-uaac rubygem):

bundle update

To create the new release, create new commit & git tag, and upload the packages:

rake release

This will create three packages:

$ ls cf-admin*
cf-admin-6.9.0.1-linux-x86.tar.gz
cf-admin-6.9.0.1-linux-x86_64.tar.gz
cf-admin-6.9.0.1-osx.tar.gz

It will then create a GitHub release and upload these assets to the release.

Finally, update scripts/installer with the new CF CLI version.

Release via Concourse

The build and release process is being automated by a http://concourse.ci system run by Stark & Wayne

The pipeline status is viewable at http://ci.starkandwayne.com:8080/pipelines/traveling-cf-admin

To setup a pipeline for your own fork (heck why not - perhaps include some additional binaries for your users)

git-repository: git@github.com:<your-org>/traveling-cf-admin.git
git-branch: master
github-org: <your-org>
github-repository: traveling-cf-admin
github-private-key: |
  -----BEGIN RSA PRIVATE KEY-----
  MIIEpAIBAAKCAQEAum1nnKm7vBDf83l0aDSpZ94nKz9FzEVb5nFTlNEa0w+D0/hb
  WJ/dxCz20Quzsqq7jiNbVsx19CjoNNZJwcXgE00hIe5tIcxyEdj1ShfzeXD2smOP
  ...
  DDRsY7ljzku3Ry9M7Iqn7aV7HaD+SY71RhBwAvzPmNhaLm31KbEM5Q==
  -----END RSA PRIVATE KEY-----
github-access-token: <your-token>

To create & upload the pipeline to your target Concourse:

fly -t snw configure traveling-cf-admin -c ci/pipeline.yml --vars-from credentials.yml
You can’t perform that action at this time.