Skip to content

Commit

Permalink
docs(aws): add aws links and resources to aws pages (#238)
Browse files Browse the repository at this point in the history
* docs(aws): add aws resource page; add links to aws pages

* rename resource to cloud-resources
  • Loading branch information
aimeeu committed Oct 6, 2020
1 parent 391b49b commit b0e9204
Show file tree
Hide file tree
Showing 9 changed files with 89 additions and 7 deletions.
2 changes: 1 addition & 1 deletion content/en/docs/armory-admin/Secrets/secrets-aws-sm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ aliases:
- /docs/spinnaker-install-admin-guides/secrets/secrets-aws-sm/
---

You can configure AWS Secrets Manager as a secrets engine for Spinnaker. For information about how to set up AWS Secrets Manager, see the [AWS documentation](https://docs.aws.amazon.com/secretsmanager/index.html).
You can configure AWS Secrets Manager as a secrets engine for Spinnaker. See the AWS Secrets Manager [User Guide](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) for how to set up AWS Secrets Manager,


## Referencing secrets stored in AWS Secrets Manager
Expand Down
4 changes: 3 additions & 1 deletion content/en/docs/armory-admin/Secrets/secrets-s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ aliases:
- /docs/spinnaker-install-admin-guides/secrets/secrets-s3/
---

This document describes how to set up Spinnaker secrets in an encrypted S3 bucket. This example uses a bucket (`mybucket`) in the `us-west-2` region to store GitHub credentials and a kubeconfig file. You reference the bucket by its URL `mybucket.us-west-2.amazonaws.com`.
This document describes how to set up Spinnaker secrets in an encrypted S3 bucket. See the S3 [Getting Started Guide](https://docs.aws.amazon.com/AmazonS3/latest/gsg/GetStartedWithS3.html) for more information on encryption in S3.

This example uses a bucket (`mybucket`) in the `us-west-2` region to store GitHub credentials and a kubeconfig file. You reference the bucket by its URL `mybucket.us-west-2.amazonaws.com`.

## Authorization
Since you're storing sensitive information, make sure to protect the bucket by restricting access and [enabling encryption](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/default-bucket-encryption.html).
Expand Down
5 changes: 3 additions & 2 deletions content/en/docs/armory-admin/aws-dr.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ The following guide describes how to configure your Spinnaker on AWS deployment


## Requirements

- The passive Spinnaker will have the same permissions as the active Spinnaker
- The active Spinnaker is configured to use AWS Aurora and S3 for persistent storage
- The active Spinnaker is configured to use AWS [Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) and [S3](https://docs.aws.amazon.com/AmazonS3/latest/gsg/GetStartedWithS3.html) for persistent storage
- Your Secret engine/store has been configured for Disaster Recovery (DR)
- All other services integrated with Spinnaker, such as your Continuous Integration (CI) system, is configured for DR

Expand All @@ -38,7 +39,7 @@ Armory recommends using a relational database for Orca and Clouddriver. For Orca
Note the following guidelines about Spinnaker storage and caching:

* S3 buckets should be set up with cross-region replication turned on. See [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the AWS documentation.
* Consider the following if you plan to use Aurora MySQL:
* Consider the following if you plan to use Aurora MySQL:
- [Replicating Amazon Aurora MySQL DB Clusters Across AWS Regions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Replication.CrossRegion.html)
- [Encrypting Aurora databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Encryption.html)
- [Backing up and Restoring Aurora clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html)
Expand Down
5 changes: 5 additions & 0 deletions content/en/docs/armory-admin/aws-subnets-configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ aliases:

Subnets determine where and how you can deploy AWS resources such as EC2 machines, ELBs and Security Groups. Configuring your Subnets correctly the first time means you won't have to update your pipelines later with changes.

## Resources

- AWS VPC [guides](https://docs.aws.amazon.com/vpc/index.html)
- AWS [VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)

## Configuring subnets

Spinnaker groups subnets into a single subnet name across multiple availability zones. This makes it simpler for end-users of Spinnaker to choose a group of subnets within a VPC that have a given purpose such as `ec2-subnets`, `elb-subnets` or `public-subnets`. This allows Spinnaker to place the machines within that group and ensure equal redundancy across zones. Below is a logical representation of how Spinnaker groups multiple subnets together. If you want to **make a subnet accessible to Spinnaker** you'll have to add a tag and value to the subnet with the following: `immutable_metadata={"purpose":"example-purpose"}`
Expand Down
4 changes: 4 additions & 0 deletions content/en/docs/cloud-resources/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Cloud Resources"
weight: 100
---
64 changes: 64 additions & 0 deletions content/en/docs/cloud-resources/resources-aws.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: AWS Resources
linkTitle: AWS
---

## Aurora database

- [User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
- [Engine selection and size](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html)
- [Database encryption](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Encryption.html) for storing sensitive data
- [Backup and restore Aurora clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html)
- [Replicate Amazon Aurora MySQL DB Clusters Across AWS Regions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Replication.CrossRegion.html)
- [Failover for Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database-failover)

## EKS

- [User Guide](https://docs.aws.amazon.com/eks/latest/userguide/what-is-eks.html)
- - [Resilience in Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/disaster-recovery-resiliency.html)

## ElastiCache for Redis

- [Amazon ElastiCache for Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/index.html)
- [Amazon ElastiCache for Redis - Exporting Backup to S3](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html)

## IAM

- [User Guide](https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html)
- IAM [roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)
- IAM [policies and permissions](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)

## Networking

- VPC [User Guide](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html)
- [VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)

## S3

- [User Guide](https://docs.aws.amazon.com/AmazonS3/latest/gsg/GetStartedWithS3.html)
- Bucket [restrictions](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html)
- Security [best practices](https://docs.aws.amazon.com/AmazonS3/latest/dev/security-best-practices.html)
- S3 buckets should be set up with cross-region [replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) turned on.

## Secrets manager

- [User Guide](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)

## Service quotas

- [User Guide](https://docs.aws.amazon.com/servicequotas/latest/userguide/getting-started.html)
- Service quotas [dashboard](https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html)
- [EC2 service quotas](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html)













Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ Please contact [Armory](mailto:hello@armory.io) if you're interested in an AWS M

The Armory Operator is a Kubernetes Operator for Spinnaker<sup>TM</sup> that makes it easier to install, deploy, and upgrade Spinnaker. The AWS Container Marketplace offering for Armory installs a version of the Armory Operator in an EKS cluster. After that, Armory can be installed in any namespace in your EKS cluster; this document assumes that Armory will be installed in the `spinnaker` namespace.

## AWS Resources

Before you install Armory on AWS, it is essential that you familiarize yourself with [relevant AWS services]({{< ref "resources-aws" >}}).

## Prerequisites

To use the Armory Marketplace offering, make sure you meet the following requirements:
Expand All @@ -24,7 +28,6 @@ To use the Armory Marketplace offering, make sure you meet the following require
* You have `cluster-admin` access on the EKS cluster.
* You have An AWS S3 bucket to store Armory application and pipeline configuration.


## Installation

This document covers the following high-level steps:
Expand Down
4 changes: 4 additions & 0 deletions content/en/docs/installation/guide/install-on-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ This document currently does not fully cover the following (see [Next Steps](#ne

Note: This document is focused on Armory, but can be adapted to install Open Source Armory by using a different Halyard container and a corresponding different Armory version

## AWS Resources

Before you install Armory on AWS, it is essential that you familiarize yourself with [relevant AWS services]({{< ref "resources-aws" >}}).

## Requirements

This document assumes the following:
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/installation/operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,13 @@ Using the Armory Operator, you can:
## Requirements

Before you start, ensure the following requirements are met:
Before you start, ensure you meet the following requirements:

- Your Kubernetes cluster runs version 1.13 or later.
- You have admission controllers enabled in Kubernetes (`-enable-admission-plugins`).
- You have `ValidatingAdmissionWebhook` enabled in the kube-apiserver. Alternatively, you can pass the `--disable-admission-controller` parameter to the to the `deployment.yaml` file that deploys the operator.
- You have admin rights to install the Custom Resource Definition (CRD) for Operator.


## Install Armory Operator

The Armory Operator has two distinct modes:
Expand Down

0 comments on commit b0e9204

Please sign in to comment.