A CLI plugin for Multi-Target Application (MTA) operations in Cloud Foundry
Clone or download
theghost5800 and ddonchev Increase TLS Handshake timeout (#47)
* Increase TLS Handshake timeout

JIRA:LMCROSSITXSADEPLOY-1263

* Add etymology of new tls handshake timeout value
Latest commit 70a7026 Nov 12, 2018
Permalink
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update documentation Oct 17, 2018
Godeps Update dependencies names to point ot the new repository Jun 8, 2018
bin make build script independent from current dir Mar 15, 2018
cfg Set version to 2.0.7 Sep 5, 2018
cli/fakes Fix computation of deploy service URL Jan 16, 2018
clients format the code via gofmt Oct 16, 2018
commands Increase TLS Handshake timeout (#47) Nov 12, 2018
go-binary Add cf-mta-plugin sources Oct 6, 2017
log Add cf-mta-plugin sources Oct 6, 2017
production-services/build-service Add cf-mta-plugin sources Oct 6, 2017
test_resources Add cf-mta-plugin sources Oct 6, 2017
testutil format the code via gofmt Oct 16, 2018
ui Add cf-mta-plugin sources Oct 6, 2017
util format the code via gofmt Oct 16, 2018
vendor Don't log http request during file upload Mar 6, 2018
.gitignore Add cf-mta-plugin sources Oct 6, 2017
.travis.yml make build script independent from current dir Mar 15, 2018
CHANGELOG.md Update CHANGELOG.md and README.md Sep 5, 2018
CONTRIBUTING.md update contributing with beginner issues section Oct 18, 2018
LICENSE Add cf-mta-plugin sources Oct 6, 2017
NOTICE Update NOTICE Jun 6, 2018
PULL_REQUEST_TEMPLATE.md Update documentation Oct 17, 2018
README.md update the documentation 2 Oct 17, 2018
build.sh make build script independent from current dir Mar 15, 2018
logo.png Update documentation Oct 17, 2018
mta_plugin.go Update dependencies names to point ot the new repository Jun 8, 2018

README.md

MultiApps logo

MultiApps CF CLI Plugin Build Status

This is a Cloud Foundry CLI plugin (formerly known as CF MTA Plugin) for performing operations on multi-target applications (MTAs) in Cloud Foundry, such as deploying, removing, viewing, etc. It is a client for the CF MultiApps Controller (formerly known as CF MTA deploy-service), which is an MTA deployer implementation for Cloud Foundry.

Requirements

  • Installed CloudFoundry CLI - ensure that CloudFoundry CLI is installed and working. For more information about installation of CloudFoundry CLI, please visit the official CloudFoundry documentation.
  • Working CF MultiApps Controller - this a CF plugin for the MultiApps Controller application. Thus, a working MultiApps Controller must be available on the CF landscape

Download and Installation

Download

The latest version of the plugin can be found in the table below. Select the plugin for your platform(Darwin, Linux, Windows) and download it.

Mac OS X 64 bit Windows 64 bit Linux 64 bit
mta-plugin-darwin mta-plugin-windows.exe mta-plugin-linux

Installation

Install the plugin, using the following command:

cf install-plugin <path-to-the-plugin> -f

🚨 Note: if you are running on an Unix-based system, you need to make the plugin executable before installing it. In order to achieve this, execute the following commad chmod +x <path-to-the-plugin>

🚨 Check whether you have a previous version installed, using the command: cf plugins. If the MtaPlugin is already installed, you need to uninstall it first and then to install the new version. You can uninstall the plugin using command cf uninstall-plugin MtaPlugin.

Usage

The MultiApps CF plugin supports the following commands:

Command Name Command Description
deploy Deploy a new multi-target app or sync changes to an existing one
undeploy Undeploy (remove) a multi-target app
mtas List all multi-target apps
mta Display health and status for a multi-target app
mta-ops List active multi-target app operations
download-mta-op-logs / dmol Download logs of multi-target app operation
bg-deploy Deploy a multi-target app using blue-green deployment
purge-mta-config Purge stale configuration entries

For more information, see the command help output available via cf [command] --help or cf help [command].

Here is an example deployment of the open-sourced spring-music:

git clone https://github.com/nvvalchev/spring-music.git
cf deploy mta-assembly/spring-music.mtar -e config.mtaext

Configuration

The configuration of the MultiApps CF plugin is done via env variables. The following are supported: DEBUG=1 - prints in standart output HTTP requests, which are from CLI client to CF deploy service backend. DEPLOY_SERVICE_URL=<deploy-service-app-url> - the plugin attempts to deduce the deploy service URL based on the CF API URL. In case of issues, or if you want to target a deploy service instance different from the default one, you can configure the targeted deploy service URL via this env variable.

How to contribute

Development

Cloning the repository

To clone the project in your Go workspace $GOPATH/src/github.com/cloudfoundry-incubator/multiapps-cli-plugin execute the following commands:

mkdir -p $GOPATH/src/github.com/cloudfoundry-incubator
cd $GOPATH/src/github.com/cloudfoundry-incubator
git clone git@github.com:cloudfoundry-incubator/multiapps-cli-plugin.git

Building new release version

You can automatically build new release for all supported platforms by calling the build.sh script with the version of the build. The version will be automatically included in the plugin, so it will be reported by cf plugins.

🚨 Note that the version parameter should follow the semver format (e.g. 1.2.3).

./build.sh 1.2.3

This will produce mta_plugin_linux_amd64, mta_plugin_darwin_amd64 and mta_plugin_windows_amd64 in the repo's root directory.

Adding dependency into the multiapps-cli-plugin

If you want to add a dependecy which to be used later on during the build and development process, you need to follow these steps:

  1. Make sure that you have godep installed(try to run godep version). If you do not have it, run the command: go get github.com/tools/godep. !!!IMPORTANT!!! Make sure that you are running on latest version of GO and godep!!!
  2. Get the dependency by executing the command: go get github.com/<package-full-name> . If you want to update it use the -u option.
  3. Use the dependecy into your code(just import and use)
  4. Make sure that the dependency is not in the Godeps/Godeps.json file(if it is, delete the entry related to it). Godeps.json file is holding information about all the dependencies which are used in the project.
  5. Run godep save ./... - this will add all the newly used dependecies into the Godeps/Godeps.json and into the vendor/ folder.

For more information about the godep tool, please refer to: godep

Further reading

Presentations, documents, and tutorials:

License

This project is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file.