Skip to content

Instantly share code, notes, and snippets.

@bowrocker
Last active September 24, 2015 18:15
Show Gist options
  • Select an option

  • Save bowrocker/6483af5aad4e15c58706 to your computer and use it in GitHub Desktop.

Select an option

Save bowrocker/6483af5aad4e15c58706 to your computer and use it in GitHub Desktop.

Feedback on delivery-cluster installation documentation

  1. [Prerequisites/ Supported OSs]: These could be broken out for clarity. Build nodes, delivery server, provisioning node, etc. It is implied below that OSX is supported for the provision node, but not mentioned here.
  2. [Prerequisites]: Verbiage describing Chef Delivery could a little more wide-ranging perhaps? Not sure it's important to mention the implementation language, etc., i.e.:

|chef delivery| is comprised of: a server that manages and visualizes the software change lifecycle through the Continuous Delivery process; build nodes that run tests and build articfacts; as well as a CLI that interfaces with the server, source control and does job control. The Delivery server hosts projects' version control using an embedded Git server, coordinates builds and tests on build nodes via push jobs, visualizes pipeline status and progress, as well as providing code review tools, and administration interfaces.

Pipelines are composed of a series of stages changes progress through, from unit test validation, build, publish, acceptance to a shared union, which feed into a single, shared pipeline for change delivery.

  1. [Prerequistites]: Perhaps slightly different wording for the parallel phases:

|chef delivery| uses |push jobs| as a job dispatcher to communicate with the build nodes through the |chef server|. Any number of build nodes may be used, but |company_name| recommends a minimum of three build nodes to provde an opportunity for the |chef delivery server| to parallelize phase runs, such as the Verify stage phases unit, lint and syntax. 4. [Create a provisioning node]: it does not seem clear whether the provisioning node can be any OS, or if it must be a linux box. 5. [Create a provisioning node]: Again not clear if this means the supported linux platforms, or that OSX is supported as implied in the section below. 6. [Set Up the Provisioning Node]: For step 1, are those the only requirements for each platform? It seems this is the only place where OSX is mentioned. 7. Missing "Amazon AWS" in the first "Configuring Provisioning for" title heading. 8. Configure Delivery section could be clearer, perhaps:

|Chef Delivery| provides multi-tencency by supporing hierarchical namespace for projects allowing more than one enterprise, with each enterprise containing any number of organizations, and each organization hosting any number of projects. Users are per enterprise. The provisioning step created the initial enterprise specified in the environment file. Next we will set up the Chef Delivery Server by creating users and organizations.

  1. [Add and Configure Users]: needs to be updated for the new UI -- the Users drop-down is no longer on the left, but on the User drop down on the upper right, for example.
  2. [Install the Delivery CLI]: We should find the package details for the OSX delivery CLI build.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment