An open API service indexing awesome lists of open source software.

https://github.com/pacphi/pcftools

Get tools in the hands of Pivotal Cloud Foundry operators... fast!
https://github.com/pacphi/pcftools

Last synced: 9 months ago
JSON representation

Get tools in the hands of Pivotal Cloud Foundry operators... fast!

Awesome Lists containing this project

README

          

# Welcome to PCF Tools

[Docker](https://www.docker.com) images and scripts that provision the most commonly used tools a Pivotal [Cloud Foundry](https://www.cloudfoundry.org) operator would need to stand-up and operate a [control-plane](https://github.com/pivotal/control-plane) via (a) a [jump-box](https://en.wikipedia.org/wiki/Jump_server) [VM](https://en.wikipedia.org/wiki/Virtual_machine) which has Docker available and/or (b) a workstation / laptop.

Tools included

- [x] [aws](https://aws.amazon.com/cli/)
- [x] [az](https://docs.microsoft.com/en-us/cli/azure/?view=azure-cli-latest)
- [x] [bosh](https://github.com/cloudfoundry/bosh-cli)
- [x] [cf](https://github.com/cloudfoundry/cli)
- [x] [cred-alert](https://github.com/pivotal-cf/cred-alert)
- [x] [credhub](https://github.com/cloudfoundry-incubator/credhub-cli)
- [x] [curl](https://curl.haxx.se)
- [x] [fly](https://github.com/concourse/concourse)
- [x] [gcloud](https://cloud.google.com/sdk/)
- [x] [git](https://git-scm.com)
- [x] [jq](https://stedolan.github.io/jq/)
- [x] [kibosh](https://github.com/cf-platform-eng/kibosh)
- [x] [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
- [x] [mc](https://www.minio.io/downloads.html#download-client)
- [x] [nodejs](https://nodejs.org/en/) and [npm](https://www.npmjs.com)
- [x] [om](https://github.com/pivotal-cf/om)
- [x] [pivnet](https://github.com/pivotal-cf/pivnet-cli)
- [x] [terraform](https://www.terraform.io/intro/index.html)
- [x] [texplate](https://github.com/pivotal-cf/texplate)
- [x] [uaac](https://github.com/cloudfoundry/cf-uaac)
- [x] [wget](https://www.gnu.org/software/wget/)

## Prerequisites

`pcftools` is built and installed in one of two ways and the miminum requirements are specified below.

### with Docker

* a Virtual machine with Docker installed
* the Dockerfile

### with Install scripts

* a pre-installed, supported operating system

## How to clone

```
git clone https://github/pacphi/pcftools
```

## Distributions

You will find `Dockerfile`s for the following images

- [x] CentOS 7
- [x] openSUSE Leap
- [x] Ubuntu Xenial (16.04)
- [x] Ubuntu Bionic Beaver (18.04)

and scripts for

- [x] macOS
- [x] Windows 10
- [x] Windows Server 2016

underneath the `builds` folder

## What about PKS?

The [pks](https://pivotal.io/platform/pivotal-container-service) CLI is available for download from [pivnet](https://network.pivotal.io), [here](https://network.pivotal.io/products/pivotal-container-service/).

> You'll need to [register](https://account.run.pivotal.io/z/uaa/sign-up) for an account and/or use UAA API token to fetch it

## Additional notes

Oftentimes we're operating in a restricted environment where resources that get created within a public cloud are not assigned public IP addresses. In this situation we may desire a network topology where the jumpbox is either in its own virtual network peered with or stood up within an existing virtual network that hosts a curated collection of common services for CI/CD.

As mentioned in the prerequisites `pcftools` assumes a jumpbox already exists. If you're looking to bootstrap a jumpbox within a new virtual network employing Terraform, have a look at the following Github repositories for inspiration

* [terraforming-aws](https://github.com/pivotal-cf/terraforming-aws)
* [terraforming-azure](https://github.com/pivotal-cf/terraforming-azure)
* [terraforming-gcp](https://github.com/pivotal-cf/terraforming-gcp)

## Bonus Material

Check out the curated collection of onboarding and deletion scripts [here](onboarding).

## Contributing

Pull requests are welcomed!