Skip to content

Commit a00dc6d

Browse files
author
Travis Tomsu
authored
Adds some potential nav side bars, logo, and sample content (spinnaker#2)
1 parent f2ce98b commit a00dc6d

15 files changed

+1130
-18
lines changed

_config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,8 @@ author:
111111
include:
112112
- .htaccess
113113
- _pages
114+
- concepts
115+
- docs
114116
exclude:
115117
- "*.sublime-project"
116118
- "*.sublime-workspace"
@@ -135,8 +137,6 @@ exclude:
135137
- Rakefile
136138
- README
137139
- tmp
138-
- /docs # ignore Minimal Mistakes /docs
139-
- /test # ignore Minimal Mistakes /test
140140
keep_files:
141141
- .git
142142
- .svn

_data/navigation.yml

+23-7
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,38 @@ main:
1313
- title: Concepts
1414
url: /concepts
1515
- title: Documentation
16-
url: /documentation
16+
url: /docs
17+
- title: Community
18+
- title: Resources
1719

1820
concepts:
1921
- title: Overview
20-
- title: Stuff
21-
- title: Moar Stuff
22+
url: /concepts
23+
- title: Groupings
24+
url: /concepts/groupings
25+
- title: Pipelines
26+
url: /concepts/pipelines
27+
children:
28+
- title: Expressions Guide
29+
url: /concepts/pipelines/expressions-guide
2230

2331
docs:
2432
- title: Overview
33+
url: /docs
2534
- title: Installation
35+
url: /docs/installation
2636
children:
2737
- title: Linux
28-
children:
29-
- title: Foo
30-
children:
31-
- title: Bar
3238
- title: AWS
3339
- title: GCE
3440
- title: Releases
41+
- title: Provider Configuration
42+
children:
43+
- title: Halyard
44+
- title: AWS
45+
- title: GCE
46+
- title: Kubernetes
47+
- title: Bells and Whistles
48+
children:
49+
- title: Jacob
50+
- title: Jessica

_includes/masthead.html

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
<div class="masthead__inner-wrap">
33
<div class="masthead__menu">
44
<nav id="site-nav" class="greedy-nav">
5-
<a class="site-title" href="{{ '/' | absolute_url }}">{{ site.title }}</a>
5+
<a class="site-title" href="{{ '/' | absolute_url }}">
6+
<img src="{{ site.url}}/assets/images/spinnaker-logo-transparent.png">
7+
</a>
68
<ul class="visible-links">
79
{% for link in site.data.navigation.main %}
810
{% if link.url contains 'http' %}
@@ -18,4 +20,4 @@
1820
</nav>
1921
</div>
2022
</div>
21-
</div>
23+
</div>

_layouts/home.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: archive
33
---
44

5-
<h3 class="archive__subtitle">{{ site.data.ui-text[site.locale].recent_posts | default: "Recent Posts" }}</h3>
5+
<!-- <h3 class="archive__subtitle">{{ site.data.ui-text[site.locale].recent_posts | default: "Recent Posts" }}</h3> -->
66

77
{% for post in paginator.posts %}
88
{% include archive-single.html %}

_sass/_masthead.scss

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
-webkit-animation-delay: 0.15s;
1111
animation-delay: 0.15s;
1212
z-index: 20;
13+
background-color: $masthead-color;
1314

1415
&__inner-wrap {
1516
@include container;
@@ -74,4 +75,4 @@
7475
padding-right: 2em;
7576
font-weight: 700;
7677
}
77-
}
78+
}

_sass/_navigation.scss

+2-2
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@
179179
display: flex;
180180
-webkit-box-align: center;
181181
align-items: center;
182-
background: $background-color;
182+
background: $masthead-color;
183183

184184
a {
185185
display: block;
@@ -555,4 +555,4 @@
555555
display: block;
556556
}
557557
}
558-
}
558+
}

_sass/_variables.scss

+3-2
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,8 @@ $xing-color : #006567 !default;
9393
$link-color : $info-color !default;
9494
$link-color-hover : mix(#000, $link-color, 25%) !default;
9595
$link-color-visited : mix(#fff, $link-color, 25%) !default;
96-
$masthead-link-color : $primary-color !default;
96+
$masthead-color : #000 !default;
97+
$masthead-link-color : #fff !default;
9798
$masthead-link-color-hover : mix(#000, $primary-color, 25%) !default;
9899

99100

@@ -125,4 +126,4 @@ $border-radius : 4px !default;
125126
$box-shadow : 0 1px 1px rgba(0, 0, 0, 0.125) !default;
126127
$navicon-width : 1.5rem !default;
127128
$navicon-height : 0.25rem !default;
128-
$global-transition : all 0.2s ease-in-out !default;
129+
$global-transition : all 0.2s ease-in-out !default;

assets/images/spinnaker-logo-og.png

33.8 KB
Loading
14.3 KB
Loading

concepts/groupings.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
layout: single
3+
title: "Groupings"
4+
sidebar:
5+
nav: concepts
6+
---
7+
8+
{% include toc %}
9+
10+
Spinnaker's top level groupings are Projects, Applications and Infrastructure.
11+
12+
## Applications
13+
14+
Applications are a logical grouping of infrastructure components - Server Groups and Clusters, Load Balancers, Security Groups and Pipelines. All components under a given Application share infrastructure credentials and top-level permissions. There are a few areas where cross-Application activities occur (e.g. a Stage that starts a Pipeline in another application), however in most areas, references are relegated to within the Application.
15+
16+
An Application typically corresponds to a particular microservice.
17+
18+
## Projects
19+
20+
Projects are arbitrary collections of infrastructure resources and pipelines. This is a convenience feature which allows you to create a dashboard containing Applications, Clusters and Pipelines by wildcard.
21+
22+
## Infrastructure
23+
24+
This is a catch net area from which potentially lists all infrastructure components across all of Spinnaker that you have access to. You can search for Applications, Clusters, Server Groups, Instances, Load Balancers and Security Groups by wildcard.
25+
26+
## Server Groups
27+
28+
A Server Group is a group of compute resource instances (VMs, container pods). The instances of a Server Group are identical and are managed as a group by the cloud platforms (e.g. ASGs, Kubernetes Replica Sets).
29+
30+
Server Groups mandatorily take on the naming convention *application-stack-detail-version*, where *stack* and *detail* are optional and *version* is system-assigned (incrementing version number). Spinnaker has no particular opinion on how the *stack* and *detail* fields are used, however it's common to use *stack* to represent a particular environment for a given microservice (e.g. dev, test, prod) and to use *detail* as an additional descriptor (e.g. feature branch, "experimental"). Finally, *version* indicates the specific Server Group, and individual instances of a Server Group are given a hash suffix in their names (e.g. "c9nzt") to uniquely identify each.
31+
32+
## Clusters
33+
34+
Clusters are logical groupings of Server Groups, by *application-stack-detail*. Clusters are used in situations where multiple Server Groups for a given microservice need to be coordinated in a single context, for example, during a red/black deployment.
35+
36+
## Load Balancers
37+
38+
Load Balancers route incoming traffic to associated and enabled Server Groups.
39+
40+
## Security Groups
41+
42+
Security Groups define traffic ingress rules for Server Groups.
43+
44+
## Resource Mappings from Spinnaker to Provider
45+
46+
Spinnaker | AWS | GCE | Kubernetes | Azure | OpenStack | Cloud Foundry
47+
---|---|---|---|---|---|---
48+
Server Group | ASG | MIG | Replica Set
49+
Load Balancer | Load Balancer | L3/L4/HTTP/internal Load Balancer | Service
50+
Security Group | Security Group | Firewall Rule | Ingress Rule

concepts/index.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
layout: single
3+
title: "Concepts"
4+
sidebar:
5+
nav: concepts
6+
---
7+
8+
{% include toc %}
9+
10+
Spinnaker is an open source, multi-cloud continuous delivery platform for releasing software changes with high velocity and confidence.
11+
12+
It provides two core sets of features: *cluster management* and *deployment management*. Below we give a top-level overview of these features.
13+
14+
## Cluster Management
15+
16+
Spinnaker's cluster management features are used to manage resources in the cloud.
17+
18+
* **Server Group**: The base resource to be managed is the *Server Group*. A Server Group identifies the machine instance profile on which to execute images along with the number of instances, and is associated with a Load Balancer and a Security Group. A Server Group is also identified with basic configuration settings, such as user account information and the region/zone in which images are deployed. When deployed, a Server Group is a collection of virtual machines running software.
19+
20+
![image](https://files.readme.io/4l9kTko1SVSIcI26iBSR_server_group.png)
21+
22+
* **Security Group**: A *Security Group* defines network traffic access. It is effectively a set of firewall rules defined by an IP range (CIDR) along with a communication protocol (e.g., TCP) and port range.
23+
* **Load Balancer**: A *Load Balancer* is associated with an ingress protocol and port range, and balances traffic among instances in the corresponding Server Group. Optionally, you can enable health checks for a load balancer, with flexiblity to define health criteria and specify the health check endpoint.
24+
* **Cluster**: A *Cluster* is a user-defined, logical grouping of Server Groups in Spinnaker.
25+
26+
## Deployment Management
27+
28+
Spinnaker's deployment management features are used to construct and manage continuous delivery workflows.
29+
30+
* **Pipeline**: *Pipelines* are the key deployment management construct in Spinnaker. They are defined by a sequence of stages, along with automated triggers (optional) that kick off the pipeline, parameters that get passed to all stages in the pipeline, and can be configured to issue notifications as the pipeline executes.<br><br>Automatic triggers can be a Jenkins job, a CRON schedule, or another pipeline. You can also manually start a pipeline. Notifications can be sent out to email, SMS or HipChat on pipeline start/complete/fail.
31+
32+
![image](https://files.readme.io/Y1X8CO7KTkO7vO9x3ZZi_pipeline.png)
33+
34+
* **Stage**: A *Stage* in Spinnaker is an atomic building block for a pipeline. Stages in a Pipeline can be sequenced in any order, though some stage sequences may be more common than others. Spinnaker comes pre-packaged with a number of stages, including:
35+
* **Bake**: Bakes an image in the specified region.
36+
* **Deploy**: Deploys a previously baked or found image.
37+
* **Destroy Server Group**: Destroys a server group.
38+
* **Disable Server Group**: Disables a server group.
39+
* **Enable Server Group**: Enables a server group.
40+
* **Find Image**: Finds a previously-baked image to deploy into an existing cluster.
41+
* **Jenkins**: Runs a Jenkins job.
42+
* **Manual Judgment**: Waits for user approval before continuing.
43+
* **Modify Scaling Process**: Suspend or resume server group scaling processes.
44+
* **Pipeline**: Runs a pipeline. This allows pipelines to be composed hierarchically.
45+
* **Quick Patch Server Group**: Quick patches a server group. Used for emergency patches.
46+
* **Resize Server Group**: Resizes a server group.
47+
* **Script**: Runs an arbitrary shell script.
48+
* **Shrink Cluster**: Shrinks a cluster.
49+
* **Wait**: Waits a specified period of time.

concepts/pipelines.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
layout: single
3+
title: "Pipelines"
4+
sidebar:
5+
nav: concepts
6+
---
7+
8+
{% include toc %}

0 commit comments

Comments
 (0)