cgp-dockstore

This tool builds an OpenStack image suitable for running tools and workflows registered at Dockstore.org packer on openstack.

• cwltool options
• Requirements
• Build Environment
  • OpenStack credentials (my-tenant-openrc.sh)
• Building the base image
  • BIP, DNS and MTU
• Customisation of the base image

cwltool options

By default --no-compute-checksum is applied to ~/.dockstore/config so that cwltool doesn't generate sha1 checksums. This is the default as it has little benefit for those writing to S3/CEPH systems as they report back MD5. If working with large files it can be a huge drain on resources if the process is on multi-core base systems.

Requirements

• Packer: 0.11.0+
• OpenStack Unified Client: 3.3.0+

Build Environment

The build is 90% controlled by environment variables.

The relevant variables are held in:

• env/platform.env
  • Instance flavor for build, floating_ip_pool
• env/versions.env
  • Version numbers for dockstore and dependencies
    • See step 2 of Onboarding
    • Please update these as needed if you want a new/alternative version of dockstore.
• env/$OS_NAME/build.env
  • Ubuntu/Alpine version specific variables
  • Docker version (due to different method of package install)

OpenStack credentials (my-tenant-openrc.sh)

Expecting Queens system:

Get this file from the Horizon interface:

Tabs: Project -> API Access

Button: Download OpenStack RC File

Building the base image

For a production image please download the tagged release bundle. Building from a check-out results in commit ids being included in the final image name.

The base image is generated simply by executing the following:

scripts/pbuild.sh <ubuntu|alpine> <NETWORK_NAME> <SECURITY_GROUP> <XXX-openrc.sh>

e.g.
scripts/pbuild.sh ubuntu my-network my-sec-grp my-tenant-openrc.sh

BIP, DNS and MTU

Please confirm with your local administrators that the bip, dns and mtu values set in the scripts/$OS_NAME/build.sh scripts are suitable for your network.

Customisation of the base image

Other custom configuration can be applied on top of the base image by providing a user_data script. An example can be found here.

To run customise run:

scripts/customise.sh <NETWORK_NAME> <SECURITY_GROUP> <XXX-openrc.sh> \
 <CUSTOM_SCRIPT> <SOURCE_IMG_ID/NAME> <DEST_IMG_NAME>

e.g.

scripts/customise.sh my-network my-sec-grp my-tenant-openrc.sh \
 my_custom.sh 'cgp-ds_ubuntu 2017-12-15 (2.0.0)' 'my-cgp-ds_ubuntu-2.0.0'