Skip to content

Commit

Permalink
Update glossary (#50)
Browse files Browse the repository at this point in the history
* Add glossary terms

* add configurable git edit url

* fix CI

* left-justify add this

* li img styling

* define more terms
  • Loading branch information
osterman authored May 15, 2018
1 parent 33c7ec0 commit 9ea6974
Show file tree
Hide file tree
Showing 80 changed files with 652 additions and 63 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ node_modules
.build-harness
build-harness/
public/*
algolia/*
tmp/*
.gitkeep
*.swp
.idea
Expand Down
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ export INSTALL_PATH ?= /usr/local/bin
export HUGO ?= hugo
export HUGO_VERSION ?= 0.40.2
export HUGO_URL ?= http://localhost.cloudposse.com:1313/
export HUGO_EDIT_BRANCH ?= master
export HUGO_EDIT_URL ?= https://github.com/cloudposse/docs/blob/$(HUGO_EDIT_BRANCH)
export HUGO_ARGS ?= --watch --buildDrafts
export HUGO_CONFIG ?= config.toml
export HUGO_PUBLISH_DIR ?= public
Expand Down Expand Up @@ -84,7 +86,8 @@ release:
@[ "$(HUGO_CONFIG)" != "config.toml" ] || (echo "Cannot release with $(HUGO_CONFIG)"; exit 1)
cat config.toml | \
sed 's,^baseURL.*,baseURL = "$(HUGO_URL)",' | \
sed 's,^publishDir.*,publishDir = "$(HUGO_PUBLISH_DIR)",' \
sed 's,^publishDir.*,publishDir = "$(HUGO_PUBLISH_DIR)",' | \
sed 's,^editURL.*,editURL = "$(HUGO_EDIT_URL)",' \
> $(HUGO_CONFIG)
@echo "Wrote $(HUGO_CONFIG) for $(HUGO_URL)..."

Expand Down
2 changes: 2 additions & 0 deletions codefresh.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ steps:
title: Running tests...
image: cloudposse/build-harness:${{BUILD_HARNESS_VERSION}}
working_directory: ./
environment:
- "HUGO_EDIT_BRANCH=${{CF_BRANCH}}"
commands:
- make deps
- make smoketest
Expand Down
5 changes: 1 addition & 4 deletions content/announcements/new-major-release-of-geodesic.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,12 @@ tags:
- geodesic
- goofys
- aws-vault
categories:
- announcements
---
Geodesic is the fastest way to get up and running with a rock solid, production grade cloud platform leveraging best-of-breed Open Source tools.

This release rips out the complicated dependencies on `Makefiles` that wrapped `helm` and `kops`. Our new philosophy is to "Keep things simple, stupid" and not try to wrap all commands under one umbrella.
This release rips out the complicated dependencies on `Makefiles` that wrapped `helm` and `kops`. Our new philosophy is to "Keep things simple, stupid" and not try to wrap all commands under one umbrella.

New with this release:
- `aws-vault` to manage sessions
- `fstab` to mount S3 buckets with `goofys`
- `/localhost` maps to caller's `$HOME` directory

Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: "Terraform Module to Manage IAM for Kops External DNS"
description: "Terraform module to provision an IAM role for `external-dns` running in a Kops cluster, and attach an IAM policy to the role with permissions to modify Route53 recordsets."
publishDate: "2018-03-31 19:40:53"
categories:
- announcements
---


Expand Down Expand Up @@ -58,4 +56,3 @@ module "kops_external_dns" {
| `policy_name` | IAM policy name |
| `policy_id` | IAM policy ID |
| `policy_arn` | IAM policy ARN |

5 changes: 0 additions & 5 deletions content/aws/cloudfront.md

This file was deleted.

5 changes: 0 additions & 5 deletions content/aws/cloudtrail.md

This file was deleted.

5 changes: 0 additions & 5 deletions content/aws/cloudwatch-logs.md

This file was deleted.

5 changes: 0 additions & 5 deletions content/aws/ecs.md

This file was deleted.

5 changes: 0 additions & 5 deletions content/aws/kms.md

This file was deleted.

5 changes: 0 additions & 5 deletions content/aws/rds.md

This file was deleted.

5 changes: 0 additions & 5 deletions content/aws/s3.md

This file was deleted.

5 changes: 0 additions & 5 deletions content/aws/ssm.md

This file was deleted.

5 changes: 0 additions & 5 deletions content/aws/vpc.md

This file was deleted.

3 changes: 3 additions & 0 deletions content/development/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: Code of Conduct
description: This is our Contributor Covenant Code of Conduct.
tags:
- open-source
- agreement
---

# Our Pledge
Expand Down
15 changes: 12 additions & 3 deletions content/glossary/12-factor.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
---
title: 12-Factor
terms:
terms:
- "12f"
- "12-factor"
- "12 factor"
- "12 factor pattern"
- "12-factor pattern"
description: ""
description: "The 12 Factor Pattern is a software methodology for building cloud-friendly (or cloud-native), scalable, maintainable applications that deploy easily on a Platform-as-a-Service (aka PaaS)."
tags:
- cloud native
- heroku
---
The 12 Factor Pattern is a software methodology for building cloud-friendly (or cloud-native), scalable, maintainable applications that deploy easily on a Platform-as-a-Service (aka PaaS).
The 12-Factor pattern is a language agnostic, “Best Practice” for writing Cloud Native applications that can be easily and consistently deployed using Continuous Integration and Continuous Delivery (“CI/CD”).

The pattern can be summed up as:
- (a) treat all apps as disposable services that receive their configuration via environment variables;
- (b) rely on backing services to provide durability;
- (c) script all changes; and
- (d) treat all environments (dev, prod, qa, etc) as identical.
11 changes: 11 additions & 0 deletions content/glossary/acm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Amazon Certificate Manager (ACM)"
terms:
- ACM
- Amazon Certificate Manager
description: "[Amazon Certificate Manager](https://aws.amazon.com/certificate-manager/) is a service that lets you easily provision, manage, and deploy TLS certificates for use with AWS services such as ELBs and CloudFront."
tags:
- aws
- tls
- pki
---
11 changes: 11 additions & 0 deletions content/glossary/ami.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Amazon Machine Image (AMI)"
description: "An [Amazon Machine Image](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html) provides the information required to launch an EC2 instance, which is a virtual server in the Amazon public cloud."
terms:
- AMI
- Amazon Machine Image
tags:
- AWS
- EC2
- Virtual Machine Image
---
12 changes: 12 additions & 0 deletions content/glossary/anti-pattern.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Anti-Pattern"
description: "An anti-pattern is the opposite of a best-practice."
terms:
- anti pattern
- anti patterns
- anti-pattern
- anti-patterns
- bad practice
- bad-practice
---
An anti-pattern is a common response to a recurring problem that is usually ineffective and risks being highly counterproductive. See [best-practices]({{< relref "glossary/best-practices.md" >}}).
12 changes: 12 additions & 0 deletions content/glossary/availability-zone.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Availability Zone (AZ)"
terms:
- az
- azs
- availability zone
- availability zones
- multi-az
- multi-availability zones
- multi availability zone
description: "An [Availability Zone](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones) is an isolated data center within a geographic region that is interconnected with other AZs through low-latency links."
---
6 changes: 4 additions & 2 deletions content/glossary/aws-vault.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: aws-vault
terms:
terms:
- "aws-vault"
- "aws vault"
description: "aws-vault is a utility for securely managing secrets with AWS Systems Manager (SSM) Parameter Store and KMS"
tags:
- aws
- IAM
---
`aws-vault` is a utility for securely managing secrets with AWS Systems Manager (SSM) Parameter Store and KMS

7 changes: 7 additions & 0 deletions content/glossary/best-practices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Best Practices"
description: "A well-understood and often published technique or methodology that, through experience and research, has proven to reliably lead to a desired result."
terms:
- "Best Practice"
- "Best Practices"
---
9 changes: 9 additions & 0 deletions content/glossary/beyondcorp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "BeyondCorp"
description: "BeyondCorp is an enterprise security model pioneered by Google that enables every employee to work from untrusted networks without the use of a VPN. One critical component is an Identity Aware Proxy."
terms:
- BeyondCorp
tags:
- IAP
- Identity Aware Proxy
---
12 changes: 12 additions & 0 deletions content/glossary/chamber.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Chamber"
description: "[Chamber](https://github.com/segmentio/chamber) is a tool by Segment IO for managing secrets with AWS SSM+KMS and exposing them as environment variables."
terms:
- Chamber
tags:
- aws
- KMS
- SSM
- secrets
- environment variables
---
10 changes: 10 additions & 0 deletions content/glossary/change-control.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Change Management"
description: "A formal process followed in order to make changes in a document, systematic process."
terms:
- change Management
- change control
tags:
- change Management
- change control
---
13 changes: 13 additions & 0 deletions content/glossary/cicd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "Continuous Integration / Continuous Delivery (CI/CD)"
terms:
- ci/cd
description: 'CI/CD is the practice of combining “Continuous Integration” with “Continuous Delivery” (aka “Continuous Deployment”)'
tags:
- codefresh
- travisci
- circleci
- jenkins
- codebuild
- codepipeline
---
11 changes: 11 additions & 0 deletions content/glossary/cloudfront.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: CloudFront
description: 'Amazon CloudFront is a content delivery network (CDN) used to improve latency for end users by hosting cacheable content on distributed global edge locations.'
terms:
- CloudFront
- Cloud Front
- CF
tags:
- AWS
- CDN
---
4 changes: 4 additions & 0 deletions content/glossary/cloudposse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ terms:
- "cloud posse"
- "cloudposse"
- "!cloudposse.com"
- "!cloudposse.net"
- "!cloudposse.org"
tags:
- DevOps
description: "Cloud Posse is a DevOps professional services company"
---
Cloud Posse is a DevOps professional services company. Let us know how we can help. Reach us at <[email protected]>.
11 changes: 11 additions & 0 deletions content/glossary/cloudtrail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: CloudTrail
description: ''
terms:
- CloudTrail
- Cloud Trail
tags:
- aws
- security
- audit logs
---
10 changes: 10 additions & 0 deletions content/glossary/cloudwatch-logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: CloudWatch Logs
description: 'Amazon CloudWatch Logs is a central store for managing logs from AWS cloud resources and applications.'
terms:
- cloudwatch Logs
tags:
- cloudwatch
- AWS
- fluentd
---
10 changes: 10 additions & 0 deletions content/glossary/cloudwatch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "CloudWatch"
description: "Amazon CloudWatch is a monitoring service for AWS cloud resources and applications."
terms:
- CloudWatch
- Cloud Watch
- AWS CloudWatch
tags:
- AWS
---
12 changes: 12 additions & 0 deletions content/glossary/cmp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Container Management Platform (CMP)"
description: ""
terms:
- CMP
- Container Management Platform
tags:
- kubernetes
- ecs
- mesos
- cattle
---
12 changes: 12 additions & 0 deletions content/glossary/code-build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "CodeBuild"
description: "[Amazon CodeBuild](https://aws.amazon.com/codebuild/) is a fully managed build service that compiles source code, runs tests, and produces software packages that are ready to deploy. With CodeBuild, you don’t need to provision, manage, and scale your own build servers."
terms:
- CodeBuild
- Code Build
tags:
- AWS
- CodePipeline
- CI/CD
---
CodeBuild scales continuously and processes multiple builds concurrently, so your builds are not left waiting in a queue. Because CodeBuild runs in AWS, it can leverage IAM Instance Profiles to assume roles to securely provision resources without exposing AWS access credentials.
9 changes: 9 additions & 0 deletions content/glossary/code-deploy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "CodeDeploy"
description: "Amazon CodeDeploy is a service that automates software deployments to AWS cloud resources."
terms:
- CodeDeploy
- Code Deploy
tags:
- AWS
---
11 changes: 11 additions & 0 deletions content/glossary/code-pipeline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "CodePipeline"
description: "[Amazon CodePipeline](https://aws.amazon.com/codepipeline/) is a continuous integration and continuous delivery service for fast and reliable application and infrastructure updates."
terms:
- CodePipeline
- Code Pipeline
tags:
- aws
- CodeBuild
- CI/code
---
11 changes: 11 additions & 0 deletions content/glossary/code-review.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Code Review (CR)"
description: "A process of reviewing Pull Requests to enable collaboration between team members, improves code quality/stability through creation of alternative solutions to problems, increase transparency through proof of work, increases team awareness by involvement, and improves business continuity through knowledge transfer."
terms:
- Code Review
- CR
tags:
- Software development
- SDLC
- Pull Request
---
Loading

0 comments on commit 9ea6974

Please sign in to comment.