You are viewing version 2.22 of the documentation, which is no longer maintained. For up-to-date documentation, see the latest version.

Installation

Installing Armory in your environment

There are several methods to install Armory:

Method Environment Description Benefits
Armory Operator Kubernetes Kubernetes operator that turns Armory’s configuration declarative GitOps friendly and ready for production use
Armory Halyard Kubernetes Versatile command line interface to configure and deploy Armory Quick Setup
Minnaker MacOS, Linux, Windows Spin up a whole environment on top of Rancher K3s to deploy Armory This is ideal if you do not have a Kubernetes cluster available and want to try out Armory

All the methods above share similar configurations, and you can migrate between them if your needs change.

Armory does not generate default hardcoded usernames and passwords for user accounts for any service. Manage these by configuring authentication and authorization for the Armory Platform.

Guides

Based on your environment, use one of the following guides to help you install Armory:

Guide Environment Description
Air Gapped Air-gapped environments that use Halyard or Operator Learn how to host your own Bill of Materials to install Armory in air-gapped environments.
AWS Marketplace AWS One-click install on the AWS marketplace.
Install on Kubernetes Halyard, Operator General workflow for installing Armory on Kubernetes
Install on AWS AWS, Halyard Installation steps for AWS, including IAM configuration
Install on AWS EC2 with Operator AWS EC2, Operator Installation steps for using Armory Operator to install Armory in a Lightweight Kubernetes (K3s) instance for POCs
Install on AKS AKS, Halyard Installation steps for Azure Kubernetes Service
Install on GKE GKE, Halyard Installation steps for GoogLe Kubernetes Engine
Install on GKE with Operator GKE, Operator Installation steps for Google Kubernetes Engine using Operator
Configuring Halyard Halyard Description of Armory-extended Halyard configurations

Armory Operator

The Armory Operator is a Kubernetes Operator that makes it easy to install, deploy, and upgrade any version of Armory.

Armory Halyard

CLI tool for configuring, deploying, and managing Spinnaker

Minnaker

Minnaker is an all-in-one, lightweight Armory environment.

Guides

This section details installing Armory in Kubernetes, Azure, GKE, and AWS (including from the AWS Marketplace). Instructions cover Halyard, Armory Operator, and air-gapped environments.

Armory Operator Reference

The Armory Operator is a Kubernetes Operator that makes it easier to install, deploy, and upgrade any version of Armory. This section describes the fields in SpinnakerService CRD and example manifests.