cube-release

This is a BOSH release for cube.

Description

Note: This is an Experimental release and is still considered work in progress.
Note: In all examples, we refer to bosh as an alias to bosh2 CLI.

Prereq

1. Install Minikube on your system. Follow the instructions to get the required tools.
2. Start your Minikube

   minikube start

   It might take some time until you see Kubectl is now configured to use the cluster, which indicates we are ready to continue.
3. Deploy and run a BOSH director. For example, refer to Stark and Wayne's tutorial on how set-up such a BOSH Lite v2 environment.
4. Run Cloud Foundry on your BOSH Lite environment using the cf-deployment. Again, you can refer to another Stark and Wayne's tutorial.

Deploying

1. Target your API and push an app.

   cf login -a https://api.bosh-lite.com \
        -u "admin" \
        -p "$(bosh2 int <path-to-cf-deployment>/deployment-vars.yml --path /cf_admin_password)" \
        --skip-ssl-validation
   
   if ! cf org test-org > /dev/null 2>&1; then cf create-org test-org; fi
   if ! cf space test-space > /dev/null 2>&1; then cf create-space test-space -o test-org; fi
   cf target -o test-org -s test-space
   

   Change into the source directory of the app you want to push.

   cf push test-app-name
   

2. Modify and deploy your cf-deployment using the provided BOSH operations file:

   • Build your release and deploy

     bosh sync-blobs
     git submodule update --init --recursive
     bosh create-release
     bosh -e <your-env-alias> upload-release
     
     bosh -e <your-env-alias> -d cf deploy <path-to-cf-deployment>/cf-deployment.yml \
          -o <path-to-cf-deployment>/operations/experimental/enable-bpm.yml \
          -o <path-to-cf-deployment>/operations/bosh-lite.yml \
          -o <path-to-cube-release>/operations/cube-bosh-operations.yml \
          --vars-store <path-to-cf-deployment>/deployment-vars.yml \
          --var=k8s_flatten_cluster_config="$(kubectl config view --flatten=true)" \
          -v system_domain=bosh-lite.com \
          -v cc_api=https://api.bosh-lite.com
     

   • Or Build and deploy with one command as a dev release

     bosh -e <your-env-alias> -d cf deploy <path-to-cf-deployment>/cf-deployment.yml \
          -o <path-to-cf-deployment>/operations/experimental/enable-bpm.yml \
          -o <path-to-cf-deployment>/operations/bosh-lite.yml \
          -o <path-to-cube-release>/operations/cube-bosh-operations.yml \
          --vars-store <path-to-cf-deployment>/deployment-vars.yml \
          --var=k8s_flatten_cluster_config="$(kubectl config view --flatten=true)" \
          -v system_domain=bosh-lite.com \
          -v cc_api=https://api.bosh-lite.com \
          -o <path-to-cube-release>/operations/dev-version.yml \
          -v cube_local_path=<path-to-cube-release>
     

   The above modification, will add a new VM(cube) to the deployment, and will use your current Minikube config file to populate the properties.cube_sync.config of your manifest.

3. In order to see if a droplet migration to the cluster was successful, you can run kubectl get pods to double check.

Properties

Path	Description
cube_sync.ccAPI	The API endpoint of the Cloud Controller
cube_sync.ccUser	The internal username for the Cloud Controller (default: internal_user)
cube_sync.ccPassword	The internal password for the Cloud Controller
cube_sync.backend	The backend to use (default: k8s)
cube_sync.config	The full Kubernetes configuration file content. Note: Avoid using certificates file references, instead you should use the file content by using the flatten option to retrieve your configuration YAML.

Contributing

1. Fork this project into your GitHub organisation or username
2. Make sure you are up-to-date with the upstream master and then create your feature branch (git checkout -b amazing-new-feature)
3. Add and commit the changes (git commit -am 'Add some amazing new feature')
4. Push to the branch (git push origin amazing-new-feature)
5. Create a PR against this repository