Repository navigation
v1.0.0
First stable release of EVS Solutions. It contains one tool, the EVS Deployment Orchestrator. The VCF 9 Phased Deployment is removed.
Versions and how they work
From this release, EVS Solutions has version numbers that follow Semantic Versioning 2.0.0.
- Versions available.
v1.0.0is the first stable release and is marked Latest. v0.1.0 is the earlier, historical release with the VCF 9 Phased Deployment; it is unsupported. Every later release follows the rules below. - Unified versions. All tools in EVS Solutions share one version number, and each release includes every tool. Tools from the same release were tested together.
- What the numbers mean. A version has three numbers,
MAJOR.MINOR.PATCH:
| Release | What it means for you | Examples in EVS Solutions |
|---|---|---|
MAJOR, such as 2.0.0 |
Something you use is removed or works differently. The release notes explain what to do | A tool or example blueprint is removed; a blueprint field is renamed or becomes required; a template parameter or stack output changes |
MINOR, such as 1.1.0 |
Something new is added. What you already use keeps working | A new tool; a new supported instance type or VCF version; a new optional blueprint field |
PATCH, such as 1.0.1 |
Fixes only. Inputs and outputs don't change | A bug fix in a deployment or teardown; a README correction |
- Finding your version. The
VERSIONfile at the repo root, with a copy in each tool's folder, holds the version, such as1.0.0. For the EVS Deployment Orchestrator, the stack's template description in the CloudFormation console starts with it, such as "Amazon EVS Deployment Orchestrator v1.0.0". - When releases come out. Releases go out when changes are ready, not on a fixed schedule. Before a MAJOR release, a release candidate such as
v2.0.0-rc.1is published as a Pre-release so you can test it first. - Older versions. Released versions never change, and every release stays on the Releases page with its tag, such as
v1.0.0. You can download any release as it was, or check it out withgit checkout v1.0.0. - Removals are announced first. A tool or feature is marked deprecated in a MINOR release. It's removed in a later MAJOR release.
- Upgrading. Before you move to a newer version, read the notes of every release in between. A MINOR or PATCH upgrade keeps what you already use working. A MAJOR upgrade can need changes, and its notes say what to do.
All tools
Added
- Release notes and history. A root
CHANGELOG.mdrecords every release, grouped by tool, and every release is on the Releases page. - Stay informed. To hear about new releases, choose Watch, Custom, Releases on the repo page.
- Support matrix and help. The root README lists the VCF versions and instance types each release supports, and has a "Get help" section.
EVS Deployment Orchestrator
Deploy/EVS-Deployment-Orchestrator/. From a single CloudFormation stack, it creates the EVS environment and its bare-metal ESXi hosts, installs VCF 9 (vCenter Server, NSX Manager, SDDC Manager and VCF Operations), and deploys an NSX edge cluster. A deployment runs unattended and takes about 4-7 hours.
Supported versions
- VCF: 9.0.2 and 9.1.0. The SDDC Manager OVA version must match
evs.vcf_versionin the blueprint. - Instance types:
i4i.metal,i7i.metal-24xlandi7i.metal-48xl.
Breaking changes
- The four instance-type example blueprints are removed. These were
i4i.metalandi7i.metal-24xl, each for VCF 9.0.2 and 9.1.0. To build a blueprint, copyblueprints/custom.all-options.example.yamland setevs.instance_type,evs.vcf_versionand the other fields markedREQUIRED.
Added
- Version in the CloudFormation console. The template's description starts with the version, such as "Amazon EVS Deployment Orchestrator v1.0.0", so the console shows which release a stack came from.
- Blueprint version check. A blueprint can name the orchestrator releases it works with, such as
requires: { edo: ">=1.0.0, <2.0.0" }. If the orchestrator's version is outside that range, it stops at launch, before it deploys anything, and names the release you need. A blueprint withoutrequiresis treated as written for v1.0.0, so it runs on every 1.x release. The orchestrator also logs its version and warns about top-level blueprint sections it doesn't use.
Changed
- The template runs the release it came from. The template checks out the
v1.0.0tag, notmain, so a stack launched or updated later runs the code its template was tested with. To get newer code, use the template from a newer release. - ESXi build matches the VCF version. When the blueprint doesn't set
evs.esx_version, the orchestrator picks the newest ESXi build with the same major.minor.patch as the VCF version, so VCF 9.1.0 gets an ESXi 9.1.0 build and not a newer patch the VCF Installer rejects. If no build matches, the deployment stops and lists the available builds. - The README documents
i7i.metal-48xland starts every deployment fromblueprints/custom.all-options.example.yaml.
What it includes
These were already in v0.1.0 and are listed here because v1.0.0 is the first stable release.
- Networking: a new VPC with the required DNS, NAT gateway, Route Server and security group, or your own VPC (BYO-VPC) if it meets the requirements in the README.
- Credentials: appliance passwords are generated and stored in AWS Secrets Manager.
- Pre-launch check:
check-quotas.pycompares the blueprint's needs with your service quotas and current usage, and prints the commands to fix any shortfall. - Teardown:
destroy.pyremoves the environment, the infrastructure or everything, back to a state that no longer bills. - Progress: CloudWatch Logs, and optional SNS notifications through
SnsTopicArn. - Access: an optional Windows jumpbox (
jumpbox.enabled) for reaching the vCenter, NSX and SDDC Manager UIs inside the VPC.
VCF 9 Phased Deployment
Breaking changes
- Removed. The EVS Deployment Orchestrator replaces it. There is no in-place upgrade: start a new deployment with the orchestrator. The last version with the phased deployment is v0.1.0.
Full history: CHANGELOG.md