From 2543ff255db40defbeabf6092c696f154601d153 Mon Sep 17 00:00:00 2001 From: Andrew Chin Date: Fri, 4 May 2018 15:22:49 -0500 Subject: [PATCH] Update release docs (#1704) --- installer/docs/BUILD.md | 33 ++++++++++++++++++++------- installer/docs/RELEASE.md | 48 +++++++++++++++++---------------------- 2 files changed, 46 insertions(+), 35 deletions(-) diff --git a/installer/docs/BUILD.md b/installer/docs/BUILD.md index fa81cac5df..f6559d2122 100644 --- a/installer/docs/BUILD.md +++ b/installer/docs/BUILD.md @@ -157,20 +157,37 @@ Make sure `DRONE_SERVER` and `DRONE_TOKEN` environment variables are set before To promote existing successful CI build to staging (`vic-product-ova-builds` bucket): -`` -$ drone deploy --param VICENGINE= --param VIC_MACHINE_SERVER= --param ADMIRAL= --param HARBOR= vmware/vic-product staging -`` +``` +$ drone deploy --param VICENGINE= \ + --param VIC_MACHINE_SERVER= \ + --param ADMIRAL= \ + --param HARBOR= \ + vmware/vic-product staging +``` To promote existing successful CI build to release (`vic-product-ova-releases` bucket): -`` -$ drone deploy --param VICENGINE= --param VIC_MACHINE_SERVER= --param ADMIRAL= --param HARBOR= vmware/vic-product release -`` +``` +$ drone deploy --param VICENGINE= \ + --param VIC_MACHINE_SERVER= \ + --param ADMIRAL= \ + --param HARBOR= \ + vmware/vic-product release +``` + +Example: + +``` +$ drone deploy --param VICENGINE=https://storage.googleapis.com/vic-engine-releases/vic_v1.4.0.tar.gz \ + --param VIC_MACHINE_SERVER=latest \ + --param ADMIRAL=v1.4.0 \ + --param HARBOR=https://storage.googleapis.com/harbor-releases/harbor-offline-installer-v1.5.0.tgz \ + vmware/vic-product release + +``` `vic_engine_version` and `harbor_version` can be specified as a URL or a file in `cwd`, eg. 'https://storage.googleapis.com/vic-engine-releases/vic_1.2.1.tar.gz' `admiral_tag` and `vic_machine_server` should be specified as docker image revision tag, eg. 'latest' `ci_build_number_to_promote` is the drone build number which will be promoted - -## Troubleshooting diff --git a/installer/docs/RELEASE.md b/installer/docs/RELEASE.md index 69b53e3427..e436474963 100644 --- a/installer/docs/RELEASE.md +++ b/installer/docs/RELEASE.md @@ -101,41 +101,35 @@ After pushing the tag to Github, go to https://github.com/vmware/vic-product/rel Select the appropriate tag -Release title follows form `vSphere Integrated Containers Appliance ` (e.g. `vSphere Integrated Containers Appliance v1.2.0-rc1`) +Release title follows form `vSphere Integrated Containers Appliance ` (e.g. `vSphere Integrated Containers Appliance v1.4.0-rc3`) -Description template for release candidates: -``` -OVA will contain: -Admiral v1.2.0-rc3 -Harbor harbor-offline-installer-v1.2.0-rc4.tgz -VIC Engine vic_1.2.0-rc4.tar.gz -VIC Machine Server digest aaaaaaa -``` +Obtain artifact hashes from CI build output at the end of `unified-ova-build` step -If the release is a release candidate, mark `This is a pre-release` +Obtain version information from `/etc/vmware/version` + +Description template for release candidates and releases: -## OVA Releases +``````` +### [Download OVA](https://storage.googleapis.com/vic-product-ova-releases/vic-v1.4.0-rc3-4824-d99cbdb4.ova) +Filesize: +SHA256: +SHA1: +MD5: -Description template for release version of the OVA: +### OVA will contain: ``` -Admiral v1.2.0 -Harbor harbor-offline-installer-v1.2.0.tgz -VIC Engine vic_1.2.0.tar.gz -VIC Machine Server digest aaaaaaa - -ef6b71d98bb6650240008b5281e97bf8592d5fd726833883718f471ed665fc5b vic-v1.2.0-aaaaaaaa.ova -85eabdf7e58fed8c09e4f3c45b2caa974ae89a16 vic-v1.2.0-aaaaaaaa.ova -ebc669f7b4cebf7501cf141e3b6fa2e3 vic-v1.2.0-aaaaaaaa.ova -4741.43 MB +appliance=v1.4.0-rc3-4824-d99cbdb4 +harbor=harbor-offline-installer-v1.5.0-rc4.tgz +engine=vic_v1.4.0-rc2.tar.gz +admiral=vmware/admiral:vic_v1.4.0-rc4 45a773ffae33 +vic-machine-server=gcr.io/eminent-nation-87317/vic-machine-server:latest b3412e003674 ``` +### [Changes from v1.3.1](https://github.com/vmware/vic-product/compare/v1.3.1...v1.4.0-rc3) +``````` -## Building Release +If the release is a release candidate, mark `This is a pre-release` -``` -git fetch --all --tags --prune -git checkout tags/v1.2.0 -``` +## Building Releases Follow instructions in [How to build VIC Product OVA](BUILD.md) -