Product installation guide samples

Overview

Armory had two standalone product lines:

• Armory Continuous Deployment Self-Hosted (CDSH), an enterprise version of open source Spinnaker.

  • Engineers created the docs site and wrote the majority of content before Armory hired tech writers. I created content and style guides, but to be honest, the tech writing team never had the resources to review and update existing content.
  • Original docs website: https://docs.armory.io/continuous-deployment/
  • Original public GitHub repo: https://github.com/armory/docs/

• Spinnaker Plugins, feature plugins for Spinnaker and Armory Continuous Deployment Self-Hosted.

  • I created the Spinnaker Plugins top-level directory and refactored some existing content into it. The engineers and I created the majority of the content in the plugins directory. When it made sense, I used a DITA-based organization. However, readers and product managers preferred a feature-based site navigation. The PMs and I were working on refactoring when Harness bought Armory.
  • Original docs website: https://docs.armory.io/plugins/
  • Original public GitHub repo: https://github.com/armory/docs/plugins/

I wrote these installation guides during my first two years at Armory.

I used Snagit’s scrolling feature to capture the screenshots. The main body content is correct, but you do see duplicate left and right menus due to the scrolling capture.

Armory Continuous Deployment Self-Hosted install guides

Install Operator and deploy Armory Continuous Deployment quickstart

I created this guide without a demo, first draft, or notes from the engineers.

Install from the AWS Marketplace

I created this guide with notes from a sales engineer.

Spinnaker plugins

Scale Agent

This example shows how to install the Scale Agent in Spinnaker using the Spinnaker Operator.

A sales engineer provided notes and the Kubernetes manifests.

Scale Agent installation

Scale Agent configuration

GitHub Integration plugin

This example shows how to install the GitHub Integration plugin in Spinnaker using Halyard.

I created this using notes from an engineer.

Install Armory CDSH in AWS EC2 using K3s

I wrote this shortly after I started with Armory. It’s based on notes I took while learning to use the product. One of the sales engineers provided instructions for configuring Lightweight Kubernetes to be publicly accessible when running on an EC2 instance.

This page became outdated and is no longer in production.

Since the Armory docs team didn’t have the resources to keep track of changes to third party products, I should not have included instructions and screenshots for how to create an S3 bucket or IAM role. Instead, I should have stated what the user needs and then linked to relevant AWS docs.