cloudfoundry-community / jumpbox-boshrelease

A BOSH release for jumpboxen

BOSH Release for jumpbox

The jumpbox BOSH release sets up a jumpbox for use with BOSH/CF/Concourse, installing utilities we've found to be generally useful for these tasks, as well as setting up custom user environments per user.

Usage

To deploy a jumpbox, you can use the BOSH manifests supplied with the repository.

bosh -e <env> -d jumpbox deploy manifests/jumpbox.yml

However, that won't generally be enough, since you should customize the configuration with your own user accounts and SSH keys. This repository ships with an example ops file that you can modify to include your users, environment setup scripts, and SSH keys.

To deploy that, use the -o option to bosh deploy:

bosh -e <env> -d jumpbox deploy \
  -o manifests/add-user-op.yml \
  manifests/jumpbox.yml

The following keys have meaning, for each user account under the jumpbox.users parameter:

1. name (Required) - The username for the account.

2. shell - The full path to the user's interactive shell. This needs to be an allowed shell (per stemcell config). Defaults to /bin/bash.

3. sudo (true|false) - Whether or not grant this user the ability to sudo as the root (or any other) user. Defaults to false.

4. password - A (cleartext) password to set for the account. By default, users are not able to authenticate via any password (and should use ssh_keys instead).

5. ssh_keys - A YAML list of SSH keys, in the form algo key-data [comment]. Note that the comment (usually in the form "[e-mail]") is optional, and has no bearing on the functionality of the key-based authentication.

6. env - The URL of a git-clonable environment repo. For an example of what you might put in such a repository, see https://github.com/jhunt/env. By default, no environment repository is assumed.

Taking Inventory

The inventory job is an errand you can colocate on your jumpboxen. It will display information about the software installed on the instance, versions, etc.

Packages installed

golang-1-linux:

• go 1.latest (currently 1.21.4) jumpbox:
• curl (on stemcell, currently 7.81.0)
• git 2.35.1
• jq 1.5
• tmux 3.2a
  • libevent 2.1.12
• tree 2.0.2
• vim 8.2.4528
• wget 1.21.3
• zip (on stemcell, currently 3.0)
• unzip (on stemcell, currently 6.0

Precompiled binaries / scripts:

• jumpbox/bins/
  • bbr 1.9.53
  • bosh 7.4.1
  • certstrap 1.2.0
  • credhub 2.9.22
  • spruce 1.29.0
  • fly 7.11.0
  • cf 6.53.0
  • cf7 7.7.4
  • cf8 8.7.4
  • esuf 0.1.2
  • genesis 2.8.11
  • jq 1.6
  • nats 1.2.0
  • safe 1.9.0
  • shield 8.7.4
  • spiff 1.0.8
  • terraform 1.1.7
  • tmate 2.4.0
  • vault 1.9.4