Example Product Name on the AWS Cloud
-Quick Start Reference Deployment
-
-May 2020
-John Doe and Jane Doe - Example Company Name, Ltd.
-Jim Smith - AWS Global Partner SA, AWS + Joe Jones - Technical Product Manager, AWS
| - - | --Visit our GitHub repository for source files and to post feedback, -report bugs, or submit feature ideas for this Quick Start. - | -
This Quick Start was created by Example Company Name, Ltd. in collaboration with Amazon Web Services (AWS). Quick Starts are automated reference deployments that use AWS CloudFormation templates to deploy key technologies on AWS, following AWS best practices.
-Overview
-This Quick Start reference deployment guide provides step-by-step instructions for deploying Example Product Name on the AWS Cloud.
-This Quick Start is for users who <target audience and usage scenario>
-| - - | --Amazon may share user-deployment information with the AWS Partner that collaborated with AWS on the Quick Start. - | -
Example Product Name on AWS
-<Describe how the software works on AWS.>
-AWS costs
-You are responsible for the cost of the AWS services and any third-party licenses used while running this Quick Start. There is no additional cost for -using the Quick Start.
-The AWS CloudFormation templates for Quick Starts include -configuration parameters that you can customize. Some of the settings, -such as the instance type, affect the cost of deployment. For cost estimates, -see the pricing pages for each AWS service you use. Prices are subject to change.
-| - - | --After you deploy the Quick Start, create AWS Cost and Usage Reports to deliver billing metrics to an Amazon Simple Storage Service (Amazon S3) bucket in your account. These reports provide cost estimates based on usage throughout each month and aggregate the data at the end of the month. For more information, see What are AWS Cost and Usage Reports? - | -
Software licenses
-These two paragraphs provide an example of the details you can provide. Provide links as appropriate.
-Example content below:
-<license information>This Quick Start requires a license for Example Product Name. To use the Quick Start in your production environment, sign up for a license at <link>. When you launch the Quick Start, place the license key in an S3 bucket and specify its location.
-If you don’t have a license, the Quick Start deploys with a trial license. The trial license gives you <n> days of free usage in a non-production environment. After this time, you can upgrade to a production license by following the instructions at <link>.
-<AMI information>The Quick Start requires a subscription to the Amazon Machine Image (AMI) for Example Product Name, which is available from AWS Marketplace. Additional pricing, terms, and conditions may apply. For instructions, see step 2 in the deployment section.
-Architecture
-Deploying this Quick Start for a new virtual private cloud (VPC) with -default parameters builds the following Example Product Name environment in the -AWS Cloud.
-
-As shown in Figure 1, the Quick Start sets up the following:
--
-
-
-
A highly available architecture that spans two Availability Zones.*
-
- -
-
A VPC configured with public and private subnets, according to AWS -best practices, to provide you with your own virtual network on AWS.*
-
-
In the public subnets:
--
-
-
-
Managed network address translation (NAT) gateways to allow outbound -internet access for resources in the private subnets.*
-
- -
-
A Linux bastion host in an Auto Scaling group to allow inbound Secure -Shell (SSH) access to EC2 instances in public and private subnets.*
-
-
In the private subnets: -* <describe any additional components>.
-*The template that deploys the Quick Start into an existing VPC skips -the components marked by asterisks and prompts you for your existing VPC -configuration.
-Planning the deployment
-Specialized knowledge
-This deployment requires a moderate level of familiarity with -AWS services. If you’re new to AWS, see Getting Started Resource Center -and AWS Training and Certification. These sites provide materials for learning how to design, -deploy, and operate your infrastructure and applications on the AWS Cloud.
-This Quick Start assumes familiarity with <knowledge expectations>.
-AWS account
-If you don’t already have an AWS account, create one at https://aws.amazon.com by following the on-screen instructions. Part of the sign-up process involves receiving a phone call and entering a PIN using the phone keypad.
-Your AWS account is automatically signed up for all AWS services. You are charged only for the services you use.
-Technical requirements
-Before you launch the Quick Start, review the following information and ensure that your account is properly configured. Otherwise, deployment might fail.
-Resource quotas
-If necessary, request service quota increases for the following resources. You might request quota increases to avoid exceeding the default limits for any resources that are shared across multiple deployments. The Service Quotas console displays your usage and quotas for some aspects of some services. For more information, see What is Service Quotas? and AWS service quotas.
-| Resource | -This deployment uses | -
|---|---|
VPCs |
-<n> |
-
Elastic IP addresses |
-<n> |
-
AWS Identity and Access Management (IAM) security groups |
-<n> |
-
IAM roles |
-<n> |
-
Auto Scaling groups |
-<n> |
-
Application Load Balancers |
-<n> |
-
Network Load Balancers |
-<n> |
-
<type> instances |
-<n> |
-
Supported Regions
-The following Regions are currently supported by this Quick Start.
--
-
-
-
us-east-1 (N. Virginia) (EXAMPLE)
-
- -
-
us-east-2 (Ohio) (EXAMPLE)
-
-
| - - | --Certain Regions are available on an opt-in basis. For more information, see Managing AWS Regions. - | -
EC2 key pairs
-Make sure that at least one Amazon EC2 key pair exists in your AWS account in the Region where you plan to deploy the Quick Start. Make note of the key pair name. You need it during deployment. To create a key pair, see Amazon EC2 key pairs and Linux instances.
-For testing or proof-of-concept purposes, we recommend creating a new key pair instead of using one that’s already being used by a production instance.
-IAM permissions
-Before launching the Quick Start, you must sign in to the AWS Management Console with IAM permissions for the resources that the templates deploy. The AdministratorAccess managed policy within IAM provides sufficient permissions, although your organization may choose to use a custom policy with more restrictions. For more information, see AWS managed policies for job functions.
-Prepare your AWS account
-Describe any setup required in the AWS account prior to template launch
-Prepare your Example Company Name, Ltd. account
-Describe any setup required in the partner portal/account prior to template launch
-Prepare for the deployment
-Describe any preparation required to complete the product build, such as obtaining licenses or placing files in S3
-Deployment options
-This Quick Start provides two deployment options:
--
-
-
-
Deploy Example Product Name into a new VPC (end-to-end deployment). This option builds a new AWS environment consisting of the VPC, subnets, NAT gateways, security groups, bastion hosts, and other infrastructure components. It then deploys Example Product Name into this new VPC.
-
- -
-
Deploy Example Product Name into an existing VPC. This option provisions Example Product Name in your existing AWS infrastructure.
-
-
The Quick Start provides separate templates for these options. It also lets you configure Classless Inter-Domain Routing (CIDR) blocks, instance types, and Example Product Name settings, as discussed later in this guide.
-Deployment steps
-+ -=== Sign in to your AWS account
--
-
-
-
Sign in to your AWS account at https://aws.amazon.com with an IAM user role that has the necessary permissions. For details, see Planning the deployment earlier in this guide.
-
- -
-
Make sure that your AWS account is configured correctly, as discussed in the Technical requirements section.
-
-
Launch the Quick Start
-| - - | --You are responsible for the cost of the AWS services used while running this Quick Start reference deployment. There is no additional cost for using this Quick Start. For full details, see the pricing pages for each AWS service used by this Quick Start. Prices are subject to change. - | -
-
-
-
-
Sign in to your AWS account, and choose one of the following options to launch the AWS CloudFormation template. For help with choosing an option, see deployment options earlier in this guide.
-
-
| - | - |
| - | - |
| - - | --If you’re deploying Example Product Name into an existing VPC, make sure that your VPC has two private subnets in different Availability Zones for the workload instances, and that the subnets aren’t shared. This Quick Start doesn’t support shared subnets. These subnets require NAT gateways in their route tables, to allow the instances to download packages and software without exposing them to the internet. - | -
Also, make sure that the domain name option in the DHCP options is configured as explained in the Amazon VPC documentation. You provide your VPC settings when you launch the Quick Start.
-Each deployment takes about 30 minutes / 1 hour to complete.
--
-
-
-
Check the AWS Region that’s displayed in the upper-right corner of the navigation bar, and change it if necessary. This is where the network infrastructure for Example Product Name will be built. The template is launched in the us-east-1 Region by default.
-
-
-
-
-
-
On the Create stack page, keep the default setting for the template URL, and then choose Next.
-
- -
-
On the Specify stack details page, change the stack name if needed. Review the parameters for the template. Provide values for the parameters that require input. For all other parameters, review the default settings and customize them as necessary.
-
-
+ -In the following tables, parameters are listed by category and described separately for the deployment options. When you finish reviewing and customizing the parameters, choose Next.
-+ -NOTE: Unless you are customizing the Quick Start templates for your own deployment projects, keep the default settings for the parameters Quick Start S3 bucket name, Quick Start S3 bucket Region, and Quick Start S3 key prefix. Changing these settings automatically updates code references to point to a new Quick Start location. For more information, see the AWS Quick Start Contributor’s Guide.
-+ -=== Parameters for a new VPC -.AWS Instance and Network Settings
-| Parameter label (name) | -Default value | -Description | -
|---|---|---|
EC2 instance type for Splunk indexer
-( |
-
|
-EC2 instance type for Splunk Indexers |
-
EC2 instance type for Splunk search head
-( |
-
|
-EC2 instance type for Splunk Search Heads |
-
Key Name
-( |
-
|
-Name of an existing EC2 KeyPair to enable SSH access to the instance |
-
Permitted CIDR for Splunk web interface
-( |
-
|
-The IP address range that is allowed to connect to the Splunk web interface. Note: a value of 0.0.0.0/0 will allow access from ANY ip address |
-
Permitted CIDR for Splunk HTTP event collector input
-( |
-
|
-The IP address range that is allowed to send data to Splunk HTTP Event Collector. Note: a value of 0.0.0.0/0 will allow access from ANY ip address |
-
Permitted CIDR for ssh
-( |
-
|
-The IP address range that is allowed to SSH to the EC2 instances. Note: a value of 0.0.0.0/0 will allow access from ANY ip address |
-
Availability Zones
-( |
-
|
-List of Availability Zones to use for the subnets in the VPC (logical order preserved). This must match the Number of Availability Zones parameter value. |
-
Number of Availability Zones
-( |
-
|
-Number of Availability Zones to use in the VPC. This must match your selections in the list of Availability Zones parameter. |
-
VPC CIDR
-( |
-
|
-The address space that will be assigned to the entire VPC where Splunk will reside. (Recommend at least a /16) |
-
Public Subnet 1 CIDR
-( |
-
|
-The address space that will be assigned to the first Splunk server subnet. (x.x.x.x/x notation) |
-
Public Subnet 2 CIDR
-( |
-
|
-The address space that will be assigned to the second Splunk server subnet. (x.x.x.x/x notation) |
-
Public Subnet 3 CIDR
-( |
-
|
-The address space that will be assigned to the second Splunk server subnet. (x.x.x.x/x notation) |
-
| Parameter label (name) | -Default value | -Description | -
|---|---|---|
Splunk Admin Password
-( |
-
|
-Admin password for Splunk. Must be at least 6 characters containing letters, numbers and symbols |
-
Shared Security Key for Cluster Nodes
-( |
-
|
-Shared cluster secret for Search Head and Indexer clusters. Must be at least 8 characters containing letters, numbers and symbols. |
-
Shared Security Key for Forwarders using Indexer Discovery
-( |
-
|
-Security key used for communication between your forwarders and the cluster master. This value should also be used by forwarders in order to retrieve list of available peer nodes from cluster master. Must be at least 8 characters containing letters, numbers and symbols. |
-
Splunk License Bucket
-( |
-
|
-Name of private S3 bucket with licenses to be accessed via authenticated requests |
-
Splunk License S3 Bucket Path
-( |
-
|
-Path to license file in S3 Bucket (without leading '/') |
-
No. of Splunk Indexers
-( |
-
|
-How many Splunk indexers to launch. [3-10] |
-
Indexer Disk Size
-( |
-
|
-The size of the attached EBS volume to the Splunk indexers. (in GB) |
-
Search Head(s) Disk Size
-( |
-
|
-The size of the attached EBS volume to the Splunk search head(s). (in GB) |
-
Index Cluster Replication Factor
-( |
-
|
-How many copies of data should be stored in the Splunk Indexer Cluster |
-
Index Cluster Search Factor
-( |
-
|
-How many copies of data should be searchable in the Splunk indexer clusters |
-
Enable Search Head Cluster?
-( |
-
|
-Do you want to build a Splunk search head cluster? |
-
Apps/Add-ons to pre-Install on Splunk Indexers
-( |
-
|
-Comma separated list of URLs of Splunk App (or Add-on) tarballs (.spl) to pre-install on indexer(s) |
-
Apps/Add-ons to pre-Install on Splunk Search Heads
-( |
-
|
-Comma separated list of URLs of Splunk App (or Add-on) tarballs (.spl) to pre-install on search head(s) |
-
| Parameter label (name) | -Default value | -Description | -
|---|---|---|
QuickStart S3 Bucket Name
-( |
-
|
-S3 bucket name for the Quick Start assets. |
-
Quick Start S3 bucket region
-( |
-
|
-The AWS Region where the Quick Start S3 bucket (QSS3BucketName) is hosted. When using your own bucket, you must specify this value. |
-
QuickStart S3 Key Prefix
-( |
-
|
-S3 key prefix for the Quick Start assets. |
-
Parameters for an existing VPC
-| Parameter label (name) | -Default value | -Description | -
|---|---|---|
EC2 instance type for Splunk indexer
-( |
-
|
-EC2 instance type for Splunk Indexers |
-
EC2 instance type for Splunk search head
-( |
-
|
-EC2 instance type for Splunk Search Heads |
-
Key Name
-( |
-
|
-Name of an existing EC2 KeyPair to enable SSH access to the instance |
-
Permitted CIDR for Splunk web interface
-( |
-
|
-The IP address range that is allowed to connect to the Splunk web interface. Note: a value of 0.0.0.0/0 will allow access from ANY ip address |
-
Permitted CIDR for Splunk HTTP event collector input
-( |
-
|
-The IP address range that is allowed to send data to Splunk HTTP Event Collector. Note: a value of 0.0.0.0/0 will allow access from ANY ip address |
-
Permitted CIDR for ssh
-( |
-
|
-The IP address range that is allowed to SSH to the EC2 instances. Note: a value of 0.0.0.0/0 will allow access from ANY ip address |
-
VPC ID
-( |
-
|
-VPC ID |
-
VPC CIDR
-( |
-
|
-VPC CIDR Block (x.x.x.x/x notation) |
-
Public Subnet 1 ID
-( |
-
|
-ID of Splunk public subnet 1 in Availability Zone 1 (e.g., subnet-xxxxxxxx) |
-
Public Subnet 2 ID
-( |
-
|
-ID of Splunk public subnet 2 in Availability Zone 2 (e.g., subnet-xxxxxxxx) |
-
Public Subnet 3 ID
-( |
-
|
-ID of Splunk public subnet 3 in Availability Zone 3 (e.g., subnet-xxxxxxxx) |
-
Number of Availability Zones
-( |
-
|
-Number of Availability Zones to use in the VPC. This must match the number public subnet IDs entered as parameters |
-
| Parameter label (name) | -Default value | -Description | -
|---|---|---|
Splunk Admin Password
-( |
-
|
-Admin password for Splunk. Must be at least 6 characters containing letters, numbers and symbols. |
-
Shared Security Key for Cluster Nodes
-( |
-
|
-Shared cluster secret for Search Head and Indexer cluster nodes. Must be at least 8 characters containing letters, numbers and symbols. |
-
Shared Security Key for Forwarders using Indexer Discovery
-( |
-
|
-Security key used for communication between your forwarders and the cluster master. This value should also be used by forwarders in order to retrieve list of available peer nodes from cluster master. Must be at least 8 characters containing letters, numbers and symbols. |
-
Splunk License Bucket
-( |
-
|
-Name of private S3 bucket with licenses to be accessed via authenticated requests |
-
Splunk License S3 Bucket Path
-( |
-
|
-Path to license file in S3 Bucket (without leading '/') |
-
No. of Splunk Indexers
-( |
-
|
-How many Splunk indexers to launch. [3-10] |
-
Indexer Disk Size
-( |
-
|
-The size of the attached EBS volume to the Splunk indexers. (in GB) |
-
Search Head(s) Disk Size
-( |
-
|
-The size of the attached EBS volume to the Splunk search head(s). (in GB) |
-
Index Cluster Replication Factor
-( |
-
|
-How many copies of data should be stored in the Splunk Indexer Cluster |
-
Index Cluster Search Factor
-( |
-
|
-How many copies of data should be searchable in the Splunk indexer clusters |
-
Enable Search Head Cluster?
-( |
-
|
-Do you want to build a Splunk search head cluster? |
-
Apps/Add-ons to pre-Install on Splunk Indexers
-( |
-
|
-Comma separated list of URLs of Splunk App (or Add-on) tarballs (.spl) to pre-install on indexer(s) |
-
Apps/Add-ons to pre-Install on Splunk Search Heads
-( |
-
|
-Comma separated list of URLs of Splunk App (or Add-on) tarballs (.spl) to pre-install on search head(s) |
-
+ -. On the Configure stack options page, you can specify tags (key-value pairs) for resources in your stack and set advanced options. When you’re finished, choose Next. -. On the Review page, review and confirm the template settings. Under Capabilities, select the two check boxes to acknowledge that the template creates IAM resources and might require the ability to automatically expand macros. -. Choose Create stack to deploy the stack. -. Monitor the status of the stack. When the status is CREATE_COMPLETE, the Example Product Name deployment is ready. -. Use the values displayed in the Outputs tab for the stack, as shown in Figure 2, to view the created resources.
-
-Test the deployment
-Post deployment steps
-Best practices for using Example Product Name on AWS
-Add any best practices for using the software.
-Security
-Add any security-related information.
-Other useful information
-Add any other details that will help the customer use the software on AWS.
-FAQ
-Q. I encountered a CREATE_FAILED error when I launched the Quick Start.
-A. If AWS CloudFormation fails to create the stack, we recommend that you relaunch the template with Rollback on failure set to Disabled. (This setting is under Advanced in the AWS CloudFormation console, Options page.) With this setting, the stack’s state is retained and the instance is left running, so you can troubleshoot the issue. (For Windows, look at the log files in %ProgramFiles%\Amazon\EC2ConfigService and C:\cfn\log.)
-| - - | --When you set Rollback on failure to Disabled, you continue to incur AWS charges for this stack. Please make sure to delete the stack when you finish troubleshooting. - | -
For additional information, see Troubleshooting AWS CloudFormation on the AWS website.
-Q. I encountered a size limitation error when I deployed the AWS CloudFormation templates.
-A. We recommend that you launch the Quick Start templates from the links in this guide or from another S3 bucket. If you deploy the templates from a local copy on your computer or from a location other than an S3 bucket, you might encounter template size limitations. For more information about AWS CloudFormation quotas, see the AWS documentation.
-Troubleshooting
-<Steps for troubleshooting the deployment go here.>
-Send us feedback
-To post feedback, submit feature ideas, or report bugs, use the Issues section of the GitHub repository for this Quick Start. To submit code, see the Quick Start Contributor’s Guide.
-Quick Start reference deployments
-See the AWS Quick Start home page.
-GitHub repository
-Visit our GitHub repository to download -the templates and scripts for this Quick Start, to post your comments, -and to share your customizations with others.
--
Notices
-This document is provided for informational purposes only. It represents AWS’s current product offerings and practices as of the date of issue of this document, which are subject to change without notice. Customers are responsible for making their own independent assessment of the information in this document and any use of AWS’s products or services, each of which is provided “as is” without warranty of any kind, whether expressed or implied. This document does not create any warranties, representations, contractual commitments, conditions, or assurances from AWS, its affiliates, suppliers, or licensors. The responsibilities and liabilities of AWS to its customers are controlled by AWS agreements, and this document is not part of, nor does it modify, any agreement between AWS and its customers.
-The software included with this paper is licensed under the Apache License, version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at http://aws.amazon.com/apache2.0/ or in the accompanying "license" file. This code is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or implied. See the License for specific language governing permissions and limitations.
-