From 8b135431864dbeda41ab0fb27053bbc89b9fb2d6 Mon Sep 17 00:00:00 2001 From: "john.d.murphy" Date: Mon, 28 Jan 2019 15:48:30 -0500 Subject: [PATCH 1/2] Admin changes to readme and sub docs --- README.md | 8 ++++---- docs/ASG-Template.md | 2 +- docs/SG-Template.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0b41c7d..af83cee 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# DOTC-Jira +# Jira -The DOTC-Jira project is a sub-project of the overarching DevOps Tool-Chain (DOTC) project. This project — and its peer projects — is designed to handle the automated deployment of common DevOps tool-chain services onto STIG-harderend, EL7-compatible Amazon EC2 instances and related AWS resources. The first part of this automation is comprised of CloudFormation (CFn) templates. Included in this project are the following templated activities: +The Jira project is a sub-project of the overarching DevOps Tool-Chain (DOTC) project. This project — and its peer projects — is designed to handle the automated deployment of common DevOps tool-chain services onto STIG-harderend, EL7-compatible Amazon EC2 instances and related AWS resources. The first part of this automation is comprised of CloudFormation (CFn) templates. Included in this project are the following templated activities: * [AutoScaling EC2](Templates/make_jira-dc_EC2-autoscale.tmplt.json) instance * [Standalone EC2](Templates/make_jira-dc_EC2-node.tmplt.json) instance @@ -17,7 +17,7 @@ The DOTC-Jira project is a sub-project of the overarching DevOps Tool-Chain (DOT Additionally, automation-scripts are provided to automate the deployment of the Jira Server software onto the relevant EC2 instances - whether stand-alone or managed via AWS's AutoScaling service. -The above _may_ be usable to &mdash or, more likely, act as a starting-point for &mdash - automate the deployment of Jira DataCenter. No assocaited testing was done: if you borrow these templates to underpin additional capabilities, please [contribute back](.github/contributing.md) the fruits of that effort (or notify us so we can link to your project). +The above _may_ be usable to &mdash or, more likely, act as a starting-point for &mdash - automate the deployment of Jira DataCenter. No associated testing was done: if you borrow these templates to underpin additional capabilities, please [contribute back](.github/contributing.md) the fruits of that effort (or notify us so we can link to your project). ## Design Assumptions @@ -59,6 +59,6 @@ These templates and scripts are also designed to ensure that Jira data is persis * Ability to destroy and recreate at will, while retaining all configuration and hosted data, has been tested. It's expected that most such actions will happen via stack-update or autoscaling actions (manual, scheduled or reactive). In the event that a stack-update results in two instances being "live" simultaneously, it will be necessary to restart the new instance after the pre-update instance terminates. This requirement is resultant Jira's built-in data-integrity protections. * Due to a [bug](https://bugzilla.redhat.com/show_bug.cgi?id=1312002) in the systemd/nfs-client implementation in RHEL/CentOS 7, reboots of instances have a better than 90% probability of hanging. This _should_ only effect template-users that deploy standalone Jira EC2s. -* The EC2 template runs [watchmaker](http://watchmaker.readthedocs.io/en/stable/) after the EC2 instance launches but before Jira has been installed. Watchmaker ensures that the resultant system is STIG-hardened. See the [Watchmaker document)(https://watchmaker.readthedocs.io/) for description of what Watchmaker does, how it does it and any additional, envionrment-specific fine-tuning that may be desired/needed. +* The EC2 template runs [watchmaker](http://watchmaker.readthedocs.io/en/stable/) after the EC2 instance launches but before Jira has been installed. Watchmaker ensures that the resultant system is STIG-hardened. See the [Watchmaker document)(https://watchmaker.readthedocs.io/) for description of what Watchmaker does, how it does it and any additional, environment-specific fine-tuning that may be desired/needed. ![Build Status](https://travis-ci.org/plus3it/dotc-jira_dc.svg?branch=master) diff --git a/docs/ASG-Template.md b/docs/ASG-Template.md index 91c2fcc..dc95248 100644 --- a/docs/ASG-Template.md +++ b/docs/ASG-Template.md @@ -2,4 +2,4 @@ The [make_jira-dc_EC2-autoscale.tmplt.json](/Templates/make_jira-dc_EC2-autoscale.tmplt.json) template — along with deployment-automation helper-scripts — creates an EC2 Launch Configuration tied to an AutoScaling Group. This configuration is intended primarily to improve the availability of the Jira service. The AutoScaling group keeps the number of active nodes at "1": in the event of a failure detected in the currently-active node, the AutoScaling group will launch a replacement node. When the replacement node reaches an acceptable state, the original node is terminated. -The improved service-availability of this deployment mentod makes this is the preferred deployment template to use. +The improved service-availability of this deployment method makes this is the preferred deployment template to use. diff --git a/docs/SG-Template.md b/docs/SG-Template.md index a0f08b7..769a869 100644 --- a/docs/SG-Template.md +++ b/docs/SG-Template.md @@ -1,3 +1,3 @@ ### Security Groups -The [make_jira-dc_SGs.tmplt.json](/Templates/make_jira-dc_SGs.tmplt.json) file sets up the security group used to gate network-access to the Jira elements. The DOTC-Jira design assumes that the entirety of the Jira-deployment exists within a security-silo. This silo contains only the Jira-service elements. The security-group created by this template is designed to foster communication between service-elements while allowing network-ingress and -egress to the silo _only_ through the Internet-facing load-balancer. +The [make_jira-dc_SGs.tmplt.json](/Templates/make_jira-dc_SGs.tmplt.json) file sets up the security group used to gate network-access to the Jira elements. The Jira design assumes that the entirety of the Jira-deployment exists within a security-silo. This silo contains only the Jira-service elements. The security-group created by this template is designed to foster communication between service-elements while allowing network-ingress and -egress to the silo _only_ through the Internet-facing load-balancer. From 4ef92ad3762dc6ac3b32e8d8b01820a8aaf89192 Mon Sep 17 00:00:00 2001 From: Thomas H Jones II Date: Tue, 29 Jan 2019 12:01:07 -0500 Subject: [PATCH 2/2] Remove invalid instance-type found by linter --- Templates/make_jira-dc_EC2-node.tmplt.json | 1 - 1 file changed, 1 deletion(-) diff --git a/Templates/make_jira-dc_EC2-node.tmplt.json b/Templates/make_jira-dc_EC2-node.tmplt.json index 981a5bb..1802a7d 100644 --- a/Templates/make_jira-dc_EC2-node.tmplt.json +++ b/Templates/make_jira-dc_EC2-node.tmplt.json @@ -194,7 +194,6 @@ "m3.large", "m3.xlarge", "m3.2xlarge", - "m3.4xlarge", "c5.large", "c5.xlarge", "c5.2xlarge",