Skip to content

Commit

Permalink
refact(images): rename images with spaces to dash
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinawoo authored and 317brian committed Jun 1, 2020
1 parent ec16622 commit e6999c8
Show file tree
Hide file tree
Showing 251 changed files with 1,593 additions and 304 deletions.
4 changes: 2 additions & 2 deletions content/en/docs/Overview/load-balancers.md
Expand Up @@ -17,7 +17,7 @@ Step 1: After you select your Application, click on the Load Balancers tab.

Step 2: Click the “Create Load Balancer” button.

![](/images/Image 2017-03-24 at 4.50.37 PM.png)
![](/images/Image-2017-03-24-at-4.50.37-PM.png)

Step 3: The Stack and Detail should be kept in mind when creating the pipeline because the pipeline’s deployment of server group should be using the same Stack and Detail.

Expand All @@ -30,4 +30,4 @@ Step 1: Go to your Load Balancers in your Applications.

Step 2: Select a Load Balancer, then to the right a column with the Load Balancer’s details should appear. Select the drop down menu and press “Delete”.

![](/images/Image 2017-03-24 at 4.56.31 PM.png)
![](/images/Image-2017-03-24-at-4.56.31-PM.png)
18 changes: 9 additions & 9 deletions content/en/docs/Overview/naming-conventions.md
Expand Up @@ -10,42 +10,42 @@ linkTitle: Naming Conventions
### Application
An application inside Spinnaker represents what you would typically find in a single code repository - and in many cases, an application maps directly to a microservice.

![](/images/Image 2017-03-24 at 3.07.57 PM.png)
![](/images/Image-2017-03-24-at-3.07.57-PM.png)

### Cluster
A server group is a regional view of servers, whereas a cluster is a world-wide view of server groups.

![](/images/Image 2017-03-24 at 3.05.04 PM.png)
![](/images/Image-2017-03-24-at-3.05.04-PM.png)

### Execution
When a pipeline runs, the end result is called an execution.

![](/images/Image 2017-03-24 at 3.06.50 PM.png)
![](/images/Image-2017-03-24-at-3.06.50-PM.png)

### Pipeline
A pipeline in Spinnaker is a series of stages linked together that can be executed serially or in parallel. All pipelines are defined in the context of an application. A typical pipeline will contain stages for “creating images”, “testing”, and “deploying”. The process of “creating images” is also commonly referred to as a “bake”.

![](/images/Image 2017-03-24 at 3.06.29 PM.png)
![](/images/Image-2017-03-24-at-3.06.29-PM.png)

### Project
A project inside Spinnaker is a logical grouping of applications. For example, we might create a project called “Spinnaker” and its applications would be “Deck”, “Orca”, “Clouddriver”, etc. Spinnaker provides a helpful dashboard view for each project to visualize its applications and status of each application contained within it.

![](/images/Image 2017-03-24 at 3.08.23 PM.png)
![](/images/Image-2017-03-24-at-3.08.23-PM.png)

### Server Group
From an Amazon Web Service (AWS) point of view, a server group is represented by an auto-scaling group (ASGs). All applications that are deployed by Spinnaker are deployed to server groups.

![](/images/Image 2017-03-24 at 3.05.04 PM.png)
![](/images/Image-2017-03-24-at-3.05.04-PM.png)

###Stage
Within a pipeline, the tasks that pipeline performs are called stages.

![](/images/Image 2017-03-24 at 3.06.29 PM.png)
![](/images/Image-2017-03-24-at-3.06.29-PM.png)

### Trigger
A trigger is the entry point to a pipeline.

![](/images/Image 2017-03-24 at 3.06.29 PM.png)
![](/images/Image-2017-03-24-at-3.06.29-PM.png)


## Spinnaker Naming Conventions
Expand All @@ -71,6 +71,6 @@ The infrastructure's version number; such as v011, v012, etc. This is automatica

In AWS, Spinnaker will name your ASGs and Launch Configurations according to the naming convention mentioned above (ie. “armoryspinnaker-prod-polling-v015”).

![](/images/Image 2017-03-24 at 3.10.53 PM.png)
![](/images/Image-2017-03-24-at-3.10.53-PM.png)

Please note that if your user definition includes a hyphen, it will disrupt the naming convention.
10 changes: 5 additions & 5 deletions content/en/docs/Overview/your-first-application.md
Expand Up @@ -13,7 +13,7 @@ An application represents the service which you are going to deploy using Spinna

When you first log in to Spinnaker, the landing page should look like this:

![](/images/Image 2017-03-24 at 3.15.34 PM.png)
![](/images/Image-2017-03-24-at-3.15.34-PM.png)

The navigation bar at the top allows you to access Projects, Applications, and Infrastructure.
The search bar allows you to search through your Infrastructure.
Expand All @@ -32,11 +32,11 @@ Remember that Spinnaker considers an application to be anything you would put in

**Step 2:** Click the “Actions” button and select from the drop-down menu “Create Application”

![](/images/Image 2017-03-24 at 3.20.41 PM.png)
![](/images/Image-2017-03-24-at-3.20.41-PM.png)

**Step 3:** Fill out the pop-up form with desired user definitions.

![](/images/Image 2017-03-24 at 3.22.30 PM.png)
![](/images/Image-2017-03-24-at-3.22.30-PM.png)

Notes:
- The name of the application cannot have hyphens. Using a hyphen in the application name interferes with the naming convention. This applies to all types of applications except for those that use the Kubernetes V2 provider to deploy.
Expand All @@ -45,7 +45,7 @@ Notes:

**Step 4:** After you fill out the form you should see this:

![](/images/Image 2017-03-24 at 3.26.40 PM.png)
![](/images/Image-2017-03-24-at-3.26.40-PM.png)

**Step 5:** If you wish to modify the settings for the application, click on “Config” for configurations.

Expand All @@ -56,4 +56,4 @@ Note that by now you should have created an application, but as you have not cre

Go to your application, click on “Config” and scroll all the way down. There will be a prompt to confirm if you would like to delete your application.

![](/images/Image 2017-03-24 at 3.28.14 PM.png)
![](/images/Image-2017-03-24-at-3.28.14-PM.png)
30 changes: 15 additions & 15 deletions content/en/docs/Overview/your-first-pipeline.md
Expand Up @@ -21,7 +21,7 @@ Things you should already have prepared beforehand for this example:

Step 1: After selecting your Application, click the Pipelines category.

![](/images/Image 2017-03-24 at 3.42.34 PM.png)
![](/images/Image-2017-03-24-at-3.42.34-PM.png)

Step 2: On this page, click the “+” icon.

Expand All @@ -39,50 +39,50 @@ Step 4: On this page you will see
- Notifications
- Description

![](/images/Image 2017-03-24 at 3.45.55 PM.png)
![](/images/Image-2017-03-24-at-3.45.55-PM.png)

Step 5: The first thing you should do is set up how your pipeline will be triggered. Scroll down to the Automated Triggers sub section. This section will allow you to select a Type first, looking like this.

![](/images/Image 2017-03-24 at 3.49.39 PM.png)
![](/images/Image-2017-03-24-at-3.49.39-PM.png)

Step 6: For this example we will select Jenkins. By adding a trigger we are defining how our pipeline will be initiated.

![](/images/Image 2017-03-24 at 3.50.27 PM.png)
![](/images/Image-2017-03-24-at-3.50.27-PM.png)

Note: The Property File is an important topic that will be covered in a [separate guide](https://docs.armory.io/user-guides/working-with-jenkins/#property-file).

Step 7: Before you test your pipeline, you may want to consider enabling or disabling the trigger via the checklist at the bottom.

Step 8: Now we add our first stage: Baking an AMI. Click the add stage button in the visual representations section.

![](/images/Image 2017-03-24 at 4.19.38 PM.png)
![](/images/Image-2017-03-24-at-4.19.38-PM.png)

Step 9: Select Bake from the different Types category.

![](/images/Image 2017-03-24 at 4.20.02 PM.png)
![](/images/Image-2017-03-24-at-4.20.02-PM.png)

Step 10: Select Amazon from the Provider list, then the region you want to bake in. Enter the name of the package that was archived by the Jenkins job.

Note: The package name should not include any version numbers. (e.g.: If your build produces a deb file named “myapp_1.27-h343”, you would want to enter “myapp” here.)
Note 2: If you would like to configure your own Base AMI under the Advanced Options, the Base OS configuration will be ignored.

![](/images/Image 2017-03-24 at 4.26.08 PM.png)
![](/images/Image-2017-03-24-at-4.26.08-PM.png)

Step 11: Now add a Deploy stage by clicking Add Stage again. In the Type category select Deploy. Deploy’s configuration settings should pop up on the screen.

![](/images/Image 2017-03-24 at 4.27.55 PM.png)
![](/images/Image-2017-03-24-at-4.27.55-PM.png)

Note: If we want to reorganize the order that the stages execute in the pipeline, we can add or remove precursor stages in the Depends On category.

Step 12: In the Deploy Configuration, click on the “Add server group” button. Pick your provider. For our example it will be AWS.

Step 13: Because this is a new application we will not choose to copy a configuration from a template. Select “Continue without a template”.

![](/images/Image 2017-03-24 at 4.32.05 PM.png)
![](/images/Image-2017-03-24-at-4.32.05-PM.png)

Step 14: The first important thing is to set up the Deploy Strategy. We will use the Highlander strategy for this example, which will ensure that only one server group for our application exists at a time.

![](/images/Image 2017-03-24 at 4.35.23 PM.png)
![](/images/Image-2017-03-24-at-4.35.23-PM.png)

Note: Different deployment strategies are important and there will be a separate guide for those (hyper link here).

Expand All @@ -94,23 +94,23 @@ Step 17: Select Instance Type as Micro Utility, then set the size as “small”

Step 18: For Capacity, select how many instances you want in your server group. For our example, we will set it at 1.

![](/images/Image 2017-03-24 at 4.39.12 PM.png)
![](/images/Image-2017-03-24-at-4.39.12-PM.png)

Step 19: Click “add”. You will be brought back to your Application and see a new Deploy Configuration. Press “Save Changes” at the bottom right of your window.

![](/images/Image 2017-03-24 at 4.42.09 PM.png)
![](/images/Image-2017-03-24-at-4.42.09-PM.png)

Step 20: Now click on the Pipelines option. You should see your new pipeline. Click on “Start Manual Execution”.

![](/images/Image 2017-03-24 at 4.43.15 PM.png)
![](/images/Image-2017-03-24-at-4.43.15-PM.png)

Step 21: You will be able to select a Build for your Jenkins job from a drop down menu. By default, Spinnaker will not recreate an AMI unless the underlying package has changed. If you would like to force it, you may use the checkbox for “Rebake”.

![](/images/Image 2017-03-24 at 4.44.32 PM.png)
![](/images/Image-2017-03-24-at-4.44.32-PM.png)

Step 22: Press “Run”, and you should see a progress bar where blue represents running and green represents complete. Gray represents not ran or canceled, which is not in our example picture.

![](/images/Image 2017-03-24 at 4.45.33 PM.png)
![](/images/Image-2017-03-24-at-4.45.33-PM.png)

If your pipeline does not succeed, refer to one of the troubleshooting sections in the [pipelines]({% link _spinnaker_user_guides/pipelines.md %}#troubleshooting), [baking]({% link _spinnaker_user_guides/baking-images.md %}#troubleshooting), or [deploying]({% link _spinnaker_user_guides/deploying.md %}#common-errors-and-troubleshooting) guides.

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/_admin_guides/ami-ancestry.md
Expand Up @@ -13,7 +13,7 @@ order: 90

To find the ancestry tool, navigate your browser to: `http://${SPINNAKER_URL}/armory/audit/`. You should find the audit dashboard:

![ancestry](/images/Image 2017-05-16 at 10.03.15 AM.png)
![ancestry](/images/Image-2017-05-16-at-10.03.15-AM.png)

Entering in an AMI ID will return the parents and descendents of the AMI that was entered.

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/_admin_guides/architecture.md
Expand Up @@ -63,7 +63,7 @@ We provide two methods of installing Spinnaker: Stand-Alone and High-Availabilit

Below is a diagram of the architecture & components deployed in a stand-alone configuration.

![](/images/Image 2017-01-26 at 12.03.11 PM.png)
![](/images/Image-2017-01-26-at-12.03.11-PM.png)


### Security Groups
Expand All @@ -86,7 +86,7 @@ By default, we create an instance with a private IP and keys which should only b

Below is a diagram of the architecture & components deployed in an HA configuration.

![](/images/Image 2017-01-26 at 11.18.35 AM.png)
![](/images/Image-2017-01-26-at-11.18.35-AM.png)

## Polling and Non-Polling environments

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/_admin_guides/ecr_registry.md
Expand Up @@ -80,4 +80,4 @@ hal deploy apply --service-names clouddriver

Now you can add ECR as a docker registry in the configuration stage

![](/images/Image 2018-12-18 at 2.02.02 PM.png)
![](/images/Image-2018-12-18-at-2.02.02-PM.png)
8 changes: 4 additions & 4 deletions content/en/docs/_admin_guides/integration_test_pipelines.md
Expand Up @@ -16,24 +16,24 @@ This guide should include:

Using Spinnaker's orchestration engine, we can quickly create pipelines that exercise the integration between Spinnaker and your cloud environment before deploying any upgrades to Spinnaker. We'll walk through creating a master pipeline that kicks off sub-pipelines asynchronously and waits for them complete.

![integration test pipeline](/images/Image 2018-04-05 at 9.25.12 PM.png)
![integration test pipeline](/images/Image-2018-04-05-at-9.25.12-PM.png)

For each stage in the pipeline, we're calling other pipelines that contain the real functionality. This essentially makes the master pipeline your "test suite runner" and reports failures.

![](/images/Image 2018-04-06 at 11.32.51 AM.png)
![](/images/Image-2018-04-06-at-11.32.51-AM.png)

### Where & When Should My Tests Run
The tests should run on a [pre-prod or staging environment](https://docs.armory.io/admin-guides/preprod_environment/) and should be integrated as part of your [Spinnaker deploy Spinnaker](https://docs.armory.io/install-guide/spinnaker-deploy-spinnaker/) pipeline. We'll use a Jenkins stage to execute the integration pipeline on the pre-prod or dev environment.

![pipeline image](/images/Image 2018-04-05 at 9.45.15 PM.png)
![pipeline image](/images/Image-2018-04-05-at-9.45.15-PM.png)

# Types of Test Pipelines
These pipelines will be based on your usage of Spinnaker and should be similar to your production pipelines. You won't need to deploy into your production accounts to validate Spinnaker functionality but you should deploy into multiple accounts from your pre-prod/dev environments. Below are some of the potential pipeline/stages you can consider.

* **Bake and Deploy** - In this pipeline, you'll want to test your Rosco and Packer template configuration to make sure bakes happen properly as well as feed the resulting AMI to a deploy stage. The application yoo choose to deploy should be a simple application. We use our [Hello Deploy application](https://github.com/armory-io/armory-hello-deploy) which has deb/rpm packaging as well as a docker image for your containerized deployments.
>Note: If you're using multiple regions make sure to test this functionality as it may expose networking issues and invalid templates.
![](/images/Image 2018-04-06 at 11.49.13 AM.png)
![](/images/Image-2018-04-06-at-11.49.13-AM.png)

* **Cluster/Server Group Operations** - For each cloud provider, you will want to ensure Spinnaker's core functionality is fully functional and valided with your accounts. We can utilize these stages, which are comprised of sub-tasks that are used elsewhere in Spinnaker. Some examples include:
- Enable/disable Cluster/Server Group
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/_admin_guides/preprod_environment.md
Expand Up @@ -68,9 +68,9 @@ SPRING_PROFILES_ACTIVE=armory,local,preprod
### Create a new Deploy Stage
Add a new deploy stage to your "Spinnaker Deploy Spinnaker" pipeline. When adding the stage and server group you can use production as the server template. You'll want to add a `manual judgement` or `integration test` stage following the deploy stage so you can confirm that your preprod environment is working as expected. Make sure to change the stack to the name chosen for your environment file, in this example: `preprod`.

![deploy configuration](/images/Image 2017-10-20 at 1.06.30 PM.png)
![deploy configuration](/images/Image-2017-10-20-at-1.06.30-PM.png)

<br/>
Your finished pipeline should resemble the following:
<br/><br/>
![preprod environment](/images/Image 2017-10-20 at 1.06.00 PM.png)
![preprod environment](/images/Image-2017-10-20-at-1.06.00-PM.png)
8 changes: 4 additions & 4 deletions content/en/docs/_admin_guides/rosco.md
Expand Up @@ -29,7 +29,7 @@ rosco:
configDir: ${services.rosco.configDir:/opt/rosco/config/packer}
```

![baking templates](/images/Image 2017-04-17 at 7.06.45 AM.png)
![baking templates](/images/Image-2017-04-17-at-7.06.45-AM.png)


### Region Templates
Expand All @@ -41,10 +41,10 @@ In some cases you'll want to bake in multiple multiple regions but in order to d
When selecting a **Base OS**, the default template will be used. The default is **Base OS** is `Ubuntu 12.04/14.0`, which uses `aws-ebs.json` and `install_package.sh`. See [Setting Up Base OS Defaults for Baking](#setting-up-base-o-s-defaults-for-baking) on how to change the defaults.

You can also specify a template in the bake stage. The example below shows the template being set to `mycompany-ebs.json` using the **Template File Name** setting for the stage. Spinnaker allows variables so you can even make each template dynamic.
![bake configuration](/images/Image 2017-08-07 at 12.45.20 PM.png)
![bake configuration](/images/Image-2017-08-07-at-12.45.20-PM.png)

Example of baking `armory-spinnaker` in CentOS (without defining the correct Base OS):
![img](/images/Screen Shot 2017-09-07 at 5.40.01 PM.png)
![img](/images/Screen-Shot-2017-09-07-at-5.40.01-PM.png)



Expand Down Expand Up @@ -94,7 +94,7 @@ This might come from your chef, puppet, ansible, or shell scripts. For the first

1. **Scale down all Spinnaker instances except 1 polling instance** :
Armory Spinnaker is set to spin up in high availability mode, this means there's a potential for a pipeline to execute on one instance and bake on another instance.
![gif](/images/Screen Recording 2017-09-05 at 06.12 PM.gif)
![gif](/images/Screen-Recording-2017-09-05-at-06.12-PM.gif)

2. **Set the healthcheck for Spinnaker to be EC2** :
If we're making changes to **rosco**, this will require you to restart Armory Spinnaker (`service armory-spinnaker restart`). This will prevent the ASG healthchecks from destroying your instance while you're working on it.
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/_admin_guides/spinnaker-on-redhat.md
Expand Up @@ -16,7 +16,7 @@ After setting up Spinnaker through the [Spinnaker-Terraform](#spinnaker-terrafor
- Any selection of `Base OS` will work, it'll be used for AMI naming. Changes can be made through the `spinnaker-local.yml`.
- `Show Advance Options` needs to be checked for the following.

![screenshot of bake stage](/images/Screen Shot 2017-07-24 at 4.39.17 PM.png)
![screenshot of bake stage](/images/Screen-Shot-2017-07-24-at-4.39.17-PM.png)


#### CentOS
Expand Down Expand Up @@ -62,12 +62,12 @@ Key: repository
Value: https://dl.bintray.com/armory/internal trusty main
```

![bake stage](/images/Image 2017-08-16 at 3.31.06 PM.png)
![bake stage](/images/Image-2017-08-16-at-3.31.06-PM.png)

2. Update `Package` field

Update the package field with the new version given to you by Armory, for example:

`armoryspinnaker=1.8.48`

![edit package field](/images/Image 2017-08-16 at 3.36.36 PM.png)
![edit package field](/images/Image-2017-08-16-at-3.36.36-PM.png)
8 changes: 4 additions & 4 deletions content/en/docs/_admin_guides/spinnaker_ha_setup.md
Expand Up @@ -14,23 +14,23 @@ order: 15
For certain components you’ll only want a single instance running on an ASG on “polling” mode. Namely Igor and Echo which need to run on a single instance so that multiple trigger events are not sent to Spinnaker and issuing multiple events for the same build.

To set this up, edit your Armory Spinnaker deploy pipeline so it looks like this.
![](/images/Image 2018-05-16 at 14.39.40.png)
![](/images/Image-2018-05-16-at-14.39.40.png)

> Note, the cloud_details set to `nonpolling` is required. On boot, Armory Spinnaker will use [/etc/default/server-env](https://kb.armory.io/aws/18-what-is-server-env/) to determine which group this instance belongs to.
#### "Disable Poller" stage
Armory includes a service (Lighthouse) that will wait for existing jobs to complete before shutting itself down.
If Fiat is enabled, make sure that you have [configured a service account](https://docs.armory.io/install-guide/authz/#configure-a-service-account).
![](/images/Image 2018-05-16 at 14.35.42.png)
![](/images/Image-2018-05-16-at-14.35.42.png)

#### "Deploy to Prod nonpolling"
Setup your deploy stage to deploy a nonpolling cluster. You can scale this cluster up to as needed.
![](/images/Image 2018-05-16 at 14.31.14.png)
![](/images/Image-2018-05-16-at-14.31.14.png)


#### "Deploy to Prod Polling"
Deploy only **1 instance**.
![](/images/Image 2018-05-16 at 14.37.01.png)
![](/images/Image-2018-05-16-at-14.37.01.png)



Expand Down

0 comments on commit e6999c8

Please sign in to comment.