├── .gitignore ├── .gitmodules ├── .metadata ├── .nojekyll ├── .taskcat.yml ├── LICENSE.txt ├── NOTICE.txt ├── README.md ├── ci ├── defaults.json └── taskcat.yml ├── docs ├── generated │ ├── parameters │ │ └── index.adoc │ ├── regions │ │ └── index.adoc │ └── services │ │ ├── index.adoc │ │ └── metadata.adoc ├── images │ ├── architecture_diagram.png │ ├── aws-quickstart-graphic.png │ └── cfn_outputs.png └── partner_editable │ ├── _settings.adoc │ ├── additional_info.adoc │ ├── architecture.adoc │ ├── deploy_steps.adoc │ ├── deployment_options.adoc │ ├── faq_troubleshooting.adoc │ ├── licenses.adoc │ ├── overview_target_and_usage.adoc │ ├── pre-reqs.adoc │ ├── product_description.adoc │ ├── regions.adoc │ ├── service_limits.adoc │ └── specialized_knowledge.adoc └── templates ├── splunk-enterprise-master.template.yaml └── splunk-enterprise.template.yaml /.gitignore: -------------------------------------------------------------------------------- 1 | # taskcat 2 | .taskcat 3 | taskcat_outputs -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "submodules/quickstart-aws-vpc"] 2 | path = submodules/quickstart-aws-vpc 3 | url = https://github.com/aws-quickstart/quickstart-aws-vpc.git 4 | branch = main 5 | [submodule "docs/boilerplate"] 6 | path = docs/boilerplate 7 | url = https://github.com/aws-quickstart/quickstart-documentation-base-common.git 8 | branch = main 9 | -------------------------------------------------------------------------------- /.metadata: -------------------------------------------------------------------------------- 1 | language_type: cloudformation -------------------------------------------------------------------------------- /.nojekyll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/aws-quickstart/quickstart-splunk-enterprise/567c81f575e8f86a5cea128c6571d7511b819843/.nojekyll -------------------------------------------------------------------------------- /.taskcat.yml: -------------------------------------------------------------------------------- 1 | project: 2 | name: quickstart-splunk-enterprise 3 | owner: quickstart@amazon.com 4 | package_lambda: false 5 | regions: 6 | - ap-northeast-1 7 | - ap-northeast-2 8 | - ap-south-1 9 | - ap-southeast-1 10 | - ap-southeast-2 11 | - ca-central-1 12 | - eu-central-1 13 | - eu-west-1 14 | - eu-west-2 15 | - sa-east-1 16 | - us-east-1 17 | - us-east-2 18 | - us-west-1 19 | - us-west-2 20 | s3_bucket: '' 21 | tests: 22 | splunk-enterprise: 23 | parameters: 24 | AvailabilityZones: $[taskcat_genaz_2] 25 | HECClientLocation: 10.0.0.0/16 26 | KeyName: taskcat-test 27 | QSS3BucketName: $[taskcat_autobucket] 28 | QSS3BucketRegion: $[taskcat_current_region] 29 | SSHClientLocation: 10.0.0.0/16 30 | SplunkAdminPassword: $[taskcat_genpass_10] 31 | SplunkClusterSecret: $[taskcat_genpass_10] 32 | SplunkIndexerDiscoverySecret: $[taskcat_genpass_10] 33 | WebClientLocation: 72.21.196.66/32 34 | regions: 35 | - us-west-1 36 | - us-east-2 37 | s3_bucket: '' 38 | template: templates/splunk-enterprise-master.template.yaml 39 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /NOTICE.txt: -------------------------------------------------------------------------------- 1 | Copyright 2016-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. 2 | 3 | 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 4 | 5 | http://aws.amazon.com/apache2.0/ 6 | 7 | or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 8 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # quickstart-splunk-enterprise 2 | ## Deprecation Notice 3 | 4 | :x: This repository is subject to deprecation in Q4 2024. For more details, [please review this announcement](https://github.com/aws-ia/.announcements/issues/1). 5 | 6 | ## This repository has been deprecated in favor of https://github.com/aws-ia/cfn-ps-splunk-enterprise. 7 | ***We will archive this repository and keep it publicly available until May 1, 2024.*** 8 | -------------------------------------------------------------------------------- /ci/defaults.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "ParameterKey": "AvailabilityZones", 4 | "ParameterValue": "$[taskcat_genaz_2]" 5 | }, 6 | { 7 | "ParameterKey": "WebClientLocation", 8 | "ParameterValue": "72.21.196.66/32" 9 | }, 10 | { 11 | "ParameterKey": "HECClientLocation", 12 | "ParameterValue": "10.0.0.0/16" 13 | }, 14 | { 15 | "ParameterKey": "KeyName", 16 | "ParameterValue": "taskcat-test" 17 | }, 18 | { 19 | "ParameterKey": "SSHClientLocation", 20 | "ParameterValue": "10.0.0.0/16" 21 | }, 22 | { 23 | "ParameterKey": "SplunkAdminPassword", 24 | "ParameterValue": "$[taskcat_genpass_10]" 25 | }, 26 | { 27 | "ParameterKey": "SplunkClusterSecret", 28 | "ParameterValue": "$[taskcat_genpass_10]" 29 | }, 30 | { 31 | "ParameterKey": "SplunkIndexerDiscoverySecret", 32 | "ParameterValue": "$[taskcat_genpass_10]" 33 | }, 34 | { 35 | "ParameterKey": "QSS3BucketName", 36 | "ParameterValue": "$[taskcat_autobucket]" 37 | } 38 | ] 39 | -------------------------------------------------------------------------------- /ci/taskcat.yml: -------------------------------------------------------------------------------- 1 | global: 2 | marketplace-ami: true 3 | owner: quickstart@amazon.com 4 | qsname: quickstart-splunk-enterprise 5 | regions: 6 | - ap-northeast-1 7 | - ap-northeast-2 8 | - ap-south-1 9 | - ap-southeast-1 10 | - ap-southeast-2 11 | - ca-central-1 12 | - eu-central-1 13 | - eu-west-1 14 | - eu-west-2 15 | - sa-east-1 16 | - us-east-1 17 | - us-east-2 18 | - us-west-1 19 | - us-west-2 20 | reporting: true 21 | tests: 22 | splunk-enterprise: 23 | parameter_input: defaults.json 24 | template_file: splunk-enterprise-master.template.yaml 25 | regions: 26 | - us-west-1 27 | - us-east-2 28 | -------------------------------------------------------------------------------- /docs/generated/parameters/index.adoc: -------------------------------------------------------------------------------- 1 | // placeholder 2 | -------------------------------------------------------------------------------- /docs/generated/regions/index.adoc: -------------------------------------------------------------------------------- 1 | // placeholder 2 | -------------------------------------------------------------------------------- /docs/generated/services/index.adoc: -------------------------------------------------------------------------------- 1 | // placeholder 2 | -------------------------------------------------------------------------------- /docs/generated/services/metadata.adoc: -------------------------------------------------------------------------------- 1 | // placeholder 2 | -------------------------------------------------------------------------------- /docs/images/architecture_diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/aws-quickstart/quickstart-splunk-enterprise/567c81f575e8f86a5cea128c6571d7511b819843/docs/images/architecture_diagram.png -------------------------------------------------------------------------------- /docs/images/aws-quickstart-graphic.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/aws-quickstart/quickstart-splunk-enterprise/567c81f575e8f86a5cea128c6571d7511b819843/docs/images/aws-quickstart-graphic.png -------------------------------------------------------------------------------- /docs/images/cfn_outputs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/aws-quickstart/quickstart-splunk-enterprise/567c81f575e8f86a5cea128c6571d7511b819843/docs/images/cfn_outputs.png -------------------------------------------------------------------------------- /docs/partner_editable/_settings.adoc: -------------------------------------------------------------------------------- 1 | :quickstart-project-name: quickstart-documentation-base 2 | :partner-product-name: Example Product Name 3 | :partner-product-short-name: Example Product Name 4 | :partner-company-name: Example Company Name, Ltd. 5 | :doc-month: May 6 | :doc-year: 2020 7 | :partner-contributors: John Doe and Jane Doe - {partner-company-name} 8 | :quickstart-contributors: Jim Smith - AWS Global Partner SA, AWS + Joe Jones - Technical Product Manager, AWS 9 | :deployment_time: 30 minutes / 1 hour 10 | :default_deployment_region: us-east-1 11 | // Uncomment these two attributes if you are leveraging 12 | // - an AWS Marketplace listing. 13 | // Additional content will be auto-generated based on these attributes. 14 | // :marketplace_subscription: 15 | // :marketplace_listing_url: https://example.com/ 16 | -------------------------------------------------------------------------------- /docs/partner_editable/additional_info.adoc: -------------------------------------------------------------------------------- 1 | // Add steps as necessary for accessing the software, post-configuration, and testing. Don’t include full usage instructions for your software, but add links to your product documentation for that information. 2 | //Should any sections not be applicable, remove them 3 | 4 | == Test the deployment 5 | // If steps are required to test the deployment, add them here. If not, remove the heading 6 | 7 | == Post deployment steps 8 | // If Post-deployment steps are required, add them here. If not, remove the heading 9 | 10 | == Best practices for using {partner-product-short-name} on AWS 11 | // Provide post-deployment best practices for using the technology on AWS, including considerations such as migrating data, backups, ensuring high performance, high availability, etc. Link to software documentation for detailed information. 12 | 13 | _Add any best practices for using the software._ 14 | 15 | == Security 16 | // Provide post-deployment best practices for using the technology on AWS, including considerations such as migrating data, backups, ensuring high performance, high availability, etc. Link to software documentation for detailed information. 17 | 18 | _Add any security-related information._ 19 | 20 | == Other useful information 21 | //Provide any other information of interest to users, especially focusing on areas where AWS or cloud usage differs from on-premises usage. 22 | 23 | _Add any other details that will help the customer use the software on AWS._ -------------------------------------------------------------------------------- /docs/partner_editable/architecture.adoc: -------------------------------------------------------------------------------- 1 | Deploying this Quick Start for a new virtual private cloud (VPC) with 2 | default parameters builds the following _{partner-product-short-name}_ environment in the 3 | AWS Cloud. 4 | 5 | // Replace this example diagram with your own. Send us your source PowerPoint file. Be sure to follow our guidelines here : http://(we should include these points on our contributors giude) 6 | [#architecture1] 7 | .Quick Start architecture for _{partner-product-short-name}_ on AWS 8 | [link=images/architecture_diagram.png] 9 | image::../images/architecture_diagram.png[Architecture,width=648,height=439] 10 | 11 | As shown in Figure 1, the Quick Start sets up the following: 12 | 13 | * A highly available architecture that spans two Availability Zones.* 14 | * A VPC configured with public and private subnets, according to AWS 15 | best practices, to provide you with your own virtual network on AWS.* 16 | 17 | In the public subnets: 18 | 19 | * Managed network address translation (NAT) gateways to allow outbound 20 | internet access for resources in the private subnets.* 21 | * A Linux bastion host in an Auto Scaling group to allow inbound Secure 22 | Shell (SSH) access to EC2 instances in public and private subnets.* 23 | 24 | In the private subnets: 25 | // Add bullet points for any additional components that are included in the deployment. Make sure that the additional components are also represented in the architecture diagram. 26 | * . 27 | 28 | *The template that deploys the Quick Start into an existing VPC skips 29 | the components marked by asterisks and prompts you for your existing VPC 30 | configuration. 31 | -------------------------------------------------------------------------------- /docs/partner_editable/deploy_steps.adoc: -------------------------------------------------------------------------------- 1 | // We need to work around Step numbers here if we are going to potentially exclude the AMI subscription 2 | === Sign in to your AWS account 3 | 4 | . Sign in to your AWS account at https://aws.amazon.com with an IAM user role that has the necessary permissions. For details, see link:#_planning_the_deployment[Planning the deployment] earlier in this guide. 5 | . Make sure that your AWS account is configured correctly, as discussed in the link:#_technical_requirements[Technical requirements] section. 6 | 7 | // Optional based on Marketplace listing. Not to be edited 8 | ifdef::marketplace_subscription[] 9 | === Subscribe to the {partner-product-short-name} AMI 10 | 11 | This Quick Start requires a subscription to the AMI for {partner-product-short-name} in AWS Marketplace. 12 | 13 | . Sign in to your AWS account. 14 | . {marketplace_listing_url}[Open the page for the {partner-product-short-name} AMI in AWS Marketplace], and then choose *Continue to Subscribe*. 15 | . Review the terms and conditions for software usage, and then choose *Accept Terms*. + 16 | A confirmation page loads, and an email confirmation is sent to the account owner. For detailed subscription instructions, see the https://aws.amazon.com/marketplace/help/200799470[AWS Marketplace documentation^]. 17 | 18 | . When the subscription process is complete, exit out of AWS Marketplace without further action. *Do not* provision the software from AWS Marketplace—the Quick Start deploys the AMI for you. 19 | endif::marketplace_subscription[] 20 | // \Not to be edited 21 | 22 | === Launch the Quick Start 23 | 24 | NOTE: 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. 25 | 26 | . 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 link:#_deployment_options[deployment options] earlier in this guide. 27 | 28 | [cols=2*] 29 | |=== 30 | ^|http://qs_launch_link[Deploy {partner-product-short-name} into a new VPC on AWS^] 31 | ^|http://qs_template_link[View template^] 32 | 33 | ^|http://qs_launch_link[Deploy {partner-product-short-name} into an existing VPC on AWS^] 34 | ^|http://qs_template_link[View template^] 35 | |=== 36 | 37 | WARNING: If you’re deploying {partner-product-short-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 https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html[shared subnets^]. These subnets require https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html[NAT gateways^] in their route tables, to allow the instances to download packages and software without exposing them to the internet. 38 | 39 | Also, make sure that the domain name option in the DHCP options is configured as explained in the http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html[Amazon VPC documentation^]. You provide your VPC settings when you launch the Quick Start. 40 | 41 | Each deployment takes about {deployment_time} to complete. 42 | 43 | [start=2] 44 | . 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 {partner-product-short-name} will be built. The template is launched in the {default_deployment_region} Region by default. 45 | 46 | // *Note:* This deployment includes Amazon EFS, which isn’t currently supported in all AWS Regions. For a current list of supported Regions, see the https://docs.aws.amazon.com/general/latest/gr/elasticfilesystem.html[endpoints and quotas webpage]. 47 | 48 | [start=3] 49 | . On the *Create stack* page, keep the default setting for the template URL, and then choose *Next*. 50 | . 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. 51 | 52 | // In the following tables, parameters are listed by category and described separately for the two deployment options: 53 | 54 | // * Parameters for deploying {partner-product-short-name} into a new VPC 55 | // * Parameters for deploying {partner-product-short-name} into an existing VPC -------------------------------------------------------------------------------- /docs/partner_editable/deployment_options.adoc: -------------------------------------------------------------------------------- 1 | // There are generally two deployment options. If additional are required, add them here 2 | 3 | This Quick Start provides two deployment options: 4 | 5 | * *Deploy {partner-product-short-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 {partner-product-short-name} into this new VPC. 6 | * *Deploy {partner-product-short-name} into an existing VPC*. This option provisions {partner-product-short-name} in your existing AWS infrastructure. 7 | 8 | The Quick Start provides separate templates for these options. It also lets you configure Classless Inter-Domain Routing (CIDR) blocks, instance types, and {partner-product-short-name} settings, as discussed later in this guide. -------------------------------------------------------------------------------- /docs/partner_editable/faq_troubleshooting.adoc: -------------------------------------------------------------------------------- 1 | // Add any tips or answers to anticipated questions. This could include the following troubleshooting information. If you don’t have any other Q&A to add, change “FAQ” to “Troubleshooting.” 2 | 3 | == FAQ 4 | 5 | *Q.* I encountered a *CREATE_FAILED* error when I launched the Quick Start. 6 | 7 | *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.) 8 | // If you’re deploying on Linux instances, provide the location for log files on Linux, or omit this sentence. 9 | 10 | WARNING: 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. 11 | 12 | For additional information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html[Troubleshooting AWS CloudFormation^] on the AWS website. 13 | 14 | *Q.* I encountered a size limitation error when I deployed the AWS CloudFormation templates. 15 | 16 | *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 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html[AWS documentation^]. 17 | 18 | 19 | == Troubleshooting 20 | 21 | -------------------------------------------------------------------------------- /docs/partner_editable/licenses.adoc: -------------------------------------------------------------------------------- 1 | // Include details about the license and how they can sign up. If no license is required, clarify that. 2 | 3 | These two paragraphs provide an example of the details you can provide. Provide links as appropriate. 4 | 5 | 6 | Example content below: 7 | 8 | _This Quick Start requires a license for {partner-product-short-name}. To use the Quick Start in your production environment, sign up for a license at . When you launch the Quick Start, place the license key in an S3 bucket and specify its location._ 9 | 10 | _If you don’t have a license, the Quick Start deploys with a trial license. The trial license gives you days of free usage in a non-production environment. After this time, you can upgrade to a production license by following the instructions at ._ 11 | 12 | // Or, if the deployment uses an AMI, update this paragraph. If it doesn’t, remove the paragraph. 13 | _The Quick Start requires a subscription to the Amazon Machine Image (AMI) for {partner-product-short-name}, which is available from https://aws.amazon.com/marketplace/[AWS Marketplace^]. Additional pricing, terms, and conditions may apply. For instructions, see link:#step-2.-subscribe-to-the-software-ami[step 2] in the deployment section._ 14 | -------------------------------------------------------------------------------- /docs/partner_editable/overview_target_and_usage.adoc: -------------------------------------------------------------------------------- 1 | // Replace the content in <> 2 | // Identify your target audience and explain how/why they would use this Quick Start. 3 | //Avoid borrowing text from third-party websites (copying text from AWS service documentation is fine). Also, avoid marketing-speak, focusing instead on the technical aspect. 4 | 5 | This Quick Start reference deployment guide provides step-by-step instructions for deploying {partner-product-short-name} on the AWS Cloud. 6 | 7 | This Quick Start is for users who -------------------------------------------------------------------------------- /docs/partner_editable/pre-reqs.adoc: -------------------------------------------------------------------------------- 1 | // If no preperation is required, remove all content from here 2 | 3 | ==== Prepare your AWS account 4 | 5 | _Describe any setup required in the AWS account prior to template launch_ 6 | 7 | ==== Prepare your {partner-company-name} account 8 | 9 | _Describe any setup required in the partner portal/account prior to template launch_ 10 | 11 | ==== Prepare for the deployment 12 | 13 | _Describe any preparation required to complete the product build, such as obtaining licenses or placing files in S3_ -------------------------------------------------------------------------------- /docs/partner_editable/product_description.adoc: -------------------------------------------------------------------------------- 1 | // Replace the content in <> 2 | // Briefly describe the software. Use consistent and clear branding. 3 | // Include the benefits of using the software on AWS, and provide details on usage scenarios. 4 | 5 | 6 | -------------------------------------------------------------------------------- /docs/partner_editable/regions.adoc: -------------------------------------------------------------------------------- 1 | The following Regions are currently supported by this Quick Start. 2 | 3 | - _us-east-1 (N. Virginia)_ (EXAMPLE) 4 | - _us-east-2 (Ohio)_ (EXAMPLE) 5 | -------------------------------------------------------------------------------- /docs/partner_editable/service_limits.adoc: -------------------------------------------------------------------------------- 1 | // Replace the in each row to specify the number of resources used in this deployment. Remove the rows for resources that aren’t used. 2 | |=== 3 | |Resource |This deployment uses 4 | 5 | // Space needed to maintain table headers 6 | |VPCs | 7 | |Elastic IP addresses | 8 | |AWS Identity and Access Management (IAM) security groups | 9 | |IAM roles | 10 | |Auto Scaling groups | 11 | |Application Load Balancers | 12 | |Network Load Balancers | 13 | | instances | 14 | |=== 15 | -------------------------------------------------------------------------------- /docs/partner_editable/specialized_knowledge.adoc: -------------------------------------------------------------------------------- 1 | // Replace the content in <> 2 | // Describe or link to specific knowledge requirements; for example: “familiarity with basic concepts in the areas of networking, database operations, and data encryption” or “familiarity with .” 3 | 4 | This Quick Start assumes familiarity with . 5 | 6 | 7 | -------------------------------------------------------------------------------- /templates/splunk-enterprise-master.template.yaml: -------------------------------------------------------------------------------- 1 | AWSTemplateFormatVersion: '2010-09-09' 2 | Description: Splunk deployment with indexer, search head clustering and cluster master. (qs-1qup6ramh) 3 | Metadata: 4 | QuickStartDocumentation: 5 | EntrypointName: "Parameters for a new VPC" 6 | AWS::CloudFormation::Interface: 7 | ParameterGroups: 8 | - Label: 9 | default: AWS Instance and Network Settings 10 | Parameters: 11 | - IndexerInstanceType 12 | - SearchHeadInstanceType 13 | - KeyName 14 | - WebClientLocation 15 | - HECClientLocation 16 | - SSHClientLocation 17 | - AvailabilityZones 18 | - NumberOfAZs 19 | - VPCCIDR 20 | - PublicSubnet1CIDR 21 | - PublicSubnet2CIDR 22 | - PublicSubnet3CIDR 23 | - Label: 24 | default: Splunk Settings 25 | Parameters: 26 | - SplunkAdminPassword 27 | - SplunkClusterSecret 28 | - SplunkIndexerDiscoverySecret 29 | - SplunkLicenseBucket 30 | - SplunkLicensePath 31 | - SplunkIndexerCount 32 | - SplunkIndexerDiskSize 33 | - SplunkSearchHeadDiskSize 34 | - SplunkReplicationFactor 35 | - SplunkSearchFactor 36 | - SHCEnabled 37 | - IndexerApps 38 | - SearchHeadApps 39 | - Label: 40 | default: AWS Quick Start Configuration 41 | Parameters: 42 | - QSS3BucketName 43 | - QSS3BucketRegion 44 | - QSS3KeyPrefix 45 | ParameterLabels: 46 | AvailabilityZones: 47 | default: Availability Zones 48 | NumberOfAZs: 49 | default: Number of Availability Zones 50 | WebClientLocation: 51 | default: Permitted CIDR for Splunk web interface 52 | HECClientLocation: 53 | default: Permitted CIDR for Splunk HTTP event collector input 54 | IndexerInstanceType: 55 | default: EC2 instance type for Splunk indexer 56 | SearchHeadInstanceType: 57 | default: EC2 instance type for Splunk search head 58 | KeyName: 59 | default: Key Name 60 | PublicSubnet1CIDR: 61 | default: Public Subnet 1 CIDR 62 | PublicSubnet2CIDR: 63 | default: Public Subnet 2 CIDR 64 | PublicSubnet3CIDR: 65 | default: Public Subnet 3 CIDR 66 | QSS3BucketName: 67 | default: QuickStart S3 Bucket Name 68 | QSS3BucketRegion: 69 | default: Quick Start S3 bucket region 70 | QSS3KeyPrefix: 71 | default: QuickStart S3 Key Prefix 72 | SHCEnabled: 73 | default: Enable Search Head Cluster? 74 | SSHClientLocation: 75 | default: Permitted CIDR for ssh 76 | SplunkAdminPassword: 77 | default: Splunk Admin Password 78 | SplunkIndexerCount: 79 | default: No. of Splunk Indexers 80 | SplunkIndexerDiskSize: 81 | default: Indexer Disk Size 82 | SplunkSearchHeadDiskSize: 83 | default: Search Head(s) Disk Size 84 | SplunkLicenseBucket: 85 | default: Splunk License Bucket 86 | SplunkLicensePath: 87 | default: Splunk License S3 Bucket Path 88 | SplunkReplicationFactor: 89 | default: Index Cluster Replication Factor 90 | SplunkSearchFactor: 91 | default: Index Cluster Search Factor 92 | SplunkClusterSecret: 93 | default: Shared Security Key for Cluster Nodes 94 | SplunkIndexerDiscoverySecret: 95 | default: Shared Security Key for Forwarders using Indexer Discovery 96 | IndexerApps: 97 | default: Apps/Add-ons to pre-Install on Splunk Indexers 98 | SearchHeadApps: 99 | default: Apps/Add-ons to pre-Install on Splunk Search Heads 100 | VPCCIDR: 101 | default: VPC CIDR 102 | Parameters: 103 | AvailabilityZones: 104 | Description: List of Availability Zones to use for the subnets in the VPC (logical 105 | order preserved). This must match the Number of Availability Zones parameter 106 | value. 107 | Type: List 108 | NumberOfAZs: 109 | AllowedValues: 110 | - '2' 111 | - '3' 112 | Default: '2' 113 | Description: Number of Availability Zones to use in the VPC. This must match your 114 | selections in the list of Availability Zones parameter. 115 | Type: String 116 | WebClientLocation: 117 | AllowedPattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$ 118 | ConstraintDescription: Must be a valid IP range in x.x.x.x/x notation. Use 0.0.0.0/0 119 | for no restrictions. 120 | Description: 'The IP address range that is allowed to connect to the Splunk web 121 | interface. Note: a value of 0.0.0.0/0 will allow access from ANY ip address' 122 | MaxLength: '19' 123 | MinLength: '9' 124 | Type: String 125 | HECClientLocation: 126 | AllowedPattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$ 127 | ConstraintDescription: Must be a valid IP range in x.x.x.x/x notation. Use 0.0.0.0/0 128 | for no restrictions. 129 | Description: 'The IP address range that is allowed to send data to Splunk HTTP 130 | Event Collector. Note: a value of 0.0.0.0/0 will allow access from ANY ip address' 131 | MaxLength: '19' 132 | MinLength: '9' 133 | Type: String 134 | IndexerInstanceType: 135 | AllowedValues: 136 | - c4.2xlarge 137 | - c4.4xlarge 138 | - c4.8xlarge 139 | - m4.2xlarge 140 | - m4.4xlarge 141 | - m4.10xlarge 142 | - c5.2xlarge 143 | - c5.4xlarge 144 | - c5.9xlarge 145 | - c5.18xlarge 146 | - i3.2xlarge 147 | - i3.4xlarge 148 | - i3.8xlarge 149 | Description: EC2 instance type for Splunk Indexers 150 | ConstraintDescription: must be a valid EC2 instance type. 151 | Default: c5.4xlarge 152 | Type: String 153 | SearchHeadInstanceType: 154 | AllowedValues: 155 | - c4.2xlarge 156 | - c4.4xlarge 157 | - c4.8xlarge 158 | - r4.4xlarge 159 | - r4.8xlarge 160 | - r4.16xlarge 161 | - c5.2xlarge 162 | - c5.4xlarge 163 | - c5.9xlarge 164 | - m5.2xlarge 165 | - m5.4xlarge 166 | - m5.12xlarge 167 | Description: EC2 instance type for Splunk Search Heads 168 | ConstraintDescription: must be a valid EC2 instance type. 169 | Default: c5.4xlarge 170 | Type: String 171 | IndexerApps: 172 | Description: Comma separated list of URLs of Splunk App (or Add-on) tarballs (.spl) 173 | to pre-install on indexer(s) 174 | Default: '' 175 | Type: CommaDelimitedList 176 | SearchHeadApps: 177 | Description: Comma separated list of URLs of Splunk App (or Add-on) tarballs (.spl) 178 | to pre-install on search head(s) 179 | Default: '' 180 | Type: CommaDelimitedList 181 | KeyName: 182 | ConstraintDescription: Must be the name of an existing EC2 KeyPair. 183 | Description: Name of an existing EC2 KeyPair to enable SSH access to the instance 184 | Type: AWS::EC2::KeyPair::KeyName 185 | PublicSubnet1CIDR: 186 | AllowedPattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$ 187 | ConstraintDescription: must be a valid IP CIDR range of the form x.x.x.x/x. 188 | Default: 10.0.1.0/24 189 | Description: The address space that will be assigned to the first Splunk server 190 | subnet. (x.x.x.x/x notation) 191 | Type: String 192 | PublicSubnet2CIDR: 193 | AllowedPattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$ 194 | ConstraintDescription: must be a valid IP CIDR range of the form x.x.x.x/x. 195 | Default: 10.0.2.0/24 196 | Description: The address space that will be assigned to the second Splunk server 197 | subnet. (x.x.x.x/x notation) 198 | Type: String 199 | PublicSubnet3CIDR: 200 | AllowedPattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$ 201 | ConstraintDescription: must be a valid IP CIDR range of the form x.x.x.x/x. 202 | Default: 10.0.3.0/24 203 | Description: The address space that will be assigned to the second Splunk server 204 | subnet. (x.x.x.x/x notation) 205 | Type: String 206 | QSS3BucketName: 207 | Default: aws-quickstart 208 | Description: S3 bucket name for the Quick Start assets. 209 | Type: String 210 | QSS3BucketRegion: 211 | Default: 'us-west-2' 212 | Description: 'The AWS Region where the Quick Start S3 bucket (QSS3BucketName) is hosted. When using your own bucket, you must specify this value.' 213 | Type: String 214 | QSS3KeyPrefix: 215 | Default: quickstart-splunk-enterprise/ 216 | Description: S3 key prefix for the Quick Start assets. 217 | Type: String 218 | SHCEnabled: 219 | AllowedValues: 220 | - 'yes' 221 | - 'no' 222 | Default: 'no' 223 | Description: Do you want to build a Splunk search head cluster? 224 | Type: String 225 | SSHClientLocation: 226 | AllowedPattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$ 227 | ConstraintDescription: Must be a valid IP range in x.x.x.x/x notation. Use 0.0.0.0/0 228 | for no restrictions. 229 | Description: 'The IP address range that is allowed to SSH to the EC2 instances. 230 | Note: a value of 0.0.0.0/0 will allow access from ANY ip address' 231 | MaxLength: '19' 232 | MinLength: '9' 233 | Type: String 234 | SplunkAdminPassword: 235 | AllowedPattern: (?=^.{6,255}$)((?=.*\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[^A-Za-z0-9])(?=.*[a-z])|(?=.*[^A-Za-z0-9])(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9]))^.* 236 | ConstraintDescription: Must be at least 8 characters containing letters, numbers 237 | and symbols. 238 | Description: Admin password for Splunk. Must be at least 6 characters containing 239 | letters, numbers and symbols 240 | MaxLength: '32' 241 | MinLength: '6' 242 | NoEcho: 'true' 243 | Type: String 244 | SplunkIndexerCount: 245 | ConstraintDescription: must be a valid number, 3-10 246 | Default: '3' 247 | Description: How many Splunk indexers to launch. [3-10] 248 | MaxValue: '10' 249 | MinValue: '3' 250 | Type: Number 251 | SplunkIndexerDiskSize: 252 | ConstraintDescription: must be a valid number, 320-16000 253 | Default: '320' 254 | Description: The size of the attached EBS volume to the Splunk indexers. (in 255 | GB) 256 | MaxValue: '16000' 257 | MinValue: '320' 258 | Type: Number 259 | SplunkSearchHeadDiskSize: 260 | ConstraintDescription: must be a valid number, 320-16000 261 | Default: '320' 262 | Description: The size of the attached EBS volume to the Splunk search head(s). (in 263 | GB) 264 | MaxValue: '16000' 265 | MinValue: '320' 266 | Type: Number 267 | SplunkLicenseBucket: 268 | Default: '' 269 | Description: Name of private S3 bucket with licenses to be accessed via authenticated 270 | requests 271 | Type: String 272 | SplunkLicensePath: 273 | Default: '' 274 | Description: Path to license file in S3 Bucket (without leading '/') 275 | Type: String 276 | SplunkReplicationFactor: 277 | ConstraintDescription: must be a valid number, 2-4 278 | Default: '2' 279 | Description: How many copies of data should be stored in the Splunk Indexer Cluster 280 | MaxValue: '4' 281 | MinValue: '2' 282 | Type: Number 283 | SplunkSearchFactor: 284 | ConstraintDescription: must be a valid number, 2-4 285 | Default: '2' 286 | Description: How many copies of data should be searchable in the Splunk indexer 287 | clusters 288 | MaxValue: '4' 289 | MinValue: '2' 290 | Type: Number 291 | SplunkClusterSecret: 292 | AllowedPattern: (?=^.{6,255}$)((?=.*\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[^A-Za-z0-9])(?=.*[a-z])|(?=.*[^A-Za-z0-9])(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9]))^.* 293 | ConstraintDescription: Must be at least 8 characters containing letters, numbers 294 | and symbols. 295 | Description: Shared cluster secret for Search Head and Indexer clusters. Must 296 | be at least 8 characters containing letters, numbers and symbols. 297 | MaxLength: '32' 298 | MinLength: '6' 299 | NoEcho: 'true' 300 | Type: String 301 | SplunkIndexerDiscoverySecret: 302 | AllowedPattern: (?=^.{6,255}$)((?=.*\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[^A-Za-z0-9])(?=.*[a-z])|(?=.*[^A-Za-z0-9])(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9]))^.* 303 | ConstraintDescription: Must be at least 8 characters containing letters, numbers 304 | and symbols. 305 | Description: >- 306 | Security key used for communication between your forwarders and the cluster 307 | master. This value should also be used by forwarders in order to retrieve list 308 | of available peer nodes from cluster master. Must be at least 8 characters containing 309 | letters, numbers and symbols. 310 | MaxLength: '32' 311 | MinLength: '8' 312 | NoEcho: 'true' 313 | Type: String 314 | VPCCIDR: 315 | AllowedPattern: (\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/(\d{1,2}) 316 | ConstraintDescription: must be a valid IP CIDR range of the form x.x.x.x/x. 317 | Default: 10.0.0.0/16 318 | Description: The address space that will be assigned to the entire VPC where Splunk 319 | will reside. (Recommend at least a /16) 320 | MaxLength: '19' 321 | MinLength: '9' 322 | Type: String 323 | Conditions: 324 | Create3AZ: !Equals 325 | - !Ref 'NumberOfAZs' 326 | - '3' 327 | UsingDefaultBucket: !Equals [!Ref QSS3BucketName, 'aws-quickstart'] 328 | Resources: 329 | VPCStack: 330 | Type: AWS::CloudFormation::Stack 331 | Properties: 332 | TemplateURL: 333 | !Sub 334 | - 'https://${S3Bucket}.s3.${S3Region}.${AWS::URLSuffix}/${QSS3KeyPrefix}submodules/quickstart-aws-vpc/templates/aws-vpc.template' 335 | - S3Region: !If [UsingDefaultBucket, !Ref 'AWS::Region', !Ref QSS3BucketRegion] 336 | S3Bucket: !If [UsingDefaultBucket, !Sub '${QSS3BucketName}-${AWS::Region}', !Ref QSS3BucketName] 337 | Parameters: 338 | AvailabilityZones: !Join 339 | - ',' 340 | - !Ref 'AvailabilityZones' 341 | CreatePrivateSubnets: 'false' 342 | KeyPairName: !Ref 'KeyName' 343 | NumberOfAZs: !Ref 'NumberOfAZs' 344 | PublicSubnet1CIDR: !Ref 'PublicSubnet1CIDR' 345 | PublicSubnet2CIDR: !Ref 'PublicSubnet2CIDR' 346 | PublicSubnet3CIDR: !Ref 'PublicSubnet3CIDR' 347 | VPCCIDR: !Ref 'VPCCIDR' 348 | TimeoutInMinutes: 15 349 | SplunkStack: 350 | Type: AWS::CloudFormation::Stack 351 | Properties: 352 | TemplateURL: 353 | !Sub 354 | - 'https://${S3Bucket}.s3.${S3Region}.${AWS::URLSuffix}/${QSS3KeyPrefix}templates/splunk-enterprise.template.yaml' 355 | - S3Region: !If [UsingDefaultBucket, !Ref 'AWS::Region', !Ref QSS3BucketRegion] 356 | S3Bucket: !If [UsingDefaultBucket, !Sub '${QSS3BucketName}-${AWS::Region}', !Ref QSS3BucketName] 357 | Parameters: 358 | VPCID: !GetAtt 'VPCStack.Outputs.VPCID' 359 | VPCCIDR: !GetAtt 'VPCStack.Outputs.VPCCIDR' 360 | PublicSubnet1ID: !GetAtt 'VPCStack.Outputs.PublicSubnet1ID' 361 | PublicSubnet2ID: !GetAtt 'VPCStack.Outputs.PublicSubnet2ID' 362 | PublicSubnet3ID: !If 363 | - Create3AZ 364 | - !GetAtt 'VPCStack.Outputs.PublicSubnet3ID' 365 | - !GetAtt 'VPCStack.Outputs.PublicSubnet2ID' 366 | NumberOfAZs: !Ref 'NumberOfAZs' 367 | IndexerInstanceType: !Ref 'IndexerInstanceType' 368 | SearchHeadInstanceType: !Ref 'SearchHeadInstanceType' 369 | SplunkAdminPassword: !Ref 'SplunkAdminPassword' 370 | SplunkClusterSecret: !Ref 'SplunkClusterSecret' 371 | SplunkIndexerDiscoverySecret: !Ref 'SplunkIndexerDiscoverySecret' 372 | SplunkLicenseBucket: !Ref 'SplunkLicenseBucket' 373 | SplunkLicensePath: !Ref 'SplunkLicensePath' 374 | KeyName: !Ref 'KeyName' 375 | SSHClientLocation: !Ref 'SSHClientLocation' 376 | HECClientLocation: !Ref 'HECClientLocation' 377 | WebClientLocation: !Ref 'WebClientLocation' 378 | SplunkIndexerCount: !Ref 'SplunkIndexerCount' 379 | SHCEnabled: !Ref 'SHCEnabled' 380 | SplunkIndexerDiskSize: !Ref 'SplunkIndexerDiskSize' 381 | SplunkReplicationFactor: !Ref 'SplunkReplicationFactor' 382 | QSS3BucketName: !Ref QSS3BucketName 383 | QSS3BucketRegion: !Ref QSS3BucketRegion 384 | QSS3KeyPrefix: !Ref QSS3KeyPrefix 385 | IndexerApps: !Join 386 | - ',' 387 | - !Ref 'IndexerApps' 388 | SearchHeadApps: !Join 389 | - ',' 390 | - !Ref 'SearchHeadApps' 391 | TimeoutInMinutes: 60 392 | Outputs: 393 | SearchHeadURL: 394 | Description: Splunk Enterprise - Search Head URL 395 | Value: !GetAtt 'SplunkStack.Outputs.SearchHeadURL' 396 | ClusterMasterURL: 397 | Description: Splunk Enterprise - Cluster Master URL 398 | Value: !GetAtt 'SplunkStack.Outputs.ClusterMasterURL' 399 | ClusterMasterManagementURL: 400 | Description: Splunk Enterprise - Cluster Master Management URL (required for Indexer 401 | Discovery) 402 | Value: !GetAtt 'SplunkStack.Outputs.ClusterMasterManagementURL' 403 | DeployerURL: 404 | Description: Splunk Enterprise - Search Head Cluster Deployer URL 405 | Value: !GetAtt 'SplunkStack.Outputs.DeployerURL' 406 | HttpEventCollectorURL: 407 | Description: HTTP Event Collector URL 408 | Value: !GetAtt 'SplunkStack.Outputs.HttpEventCollectorURL' 409 | HttpEventCollectorToken: 410 | Description: HTTP Event Collector Token 411 | Value: !GetAtt 'SplunkStack.Outputs.HttpEventCollectorToken' 412 | -------------------------------------------------------------------------------- /templates/splunk-enterprise.template.yaml: -------------------------------------------------------------------------------- 1 | AWSTemplateFormatVersion: '2010-09-09' 2 | Description: Splunk deployment with indexer, search head clustering and cluster master. 3 | (qs-1qup6ramp) 4 | Metadata: 5 | QuickStartDocumentation: 6 | EntrypointName: "Parameters for an existing VPC" 7 | AWSAMIRegionMap: 8 | Filters: 9 | SPLUNKENTHVM: 10 | name: splunk_marketplace_AMI_* 11 | owner-alias: aws-marketplace 12 | product-code.type: marketplace 13 | AWS::CloudFormation::Interface: 14 | ParameterGroups: 15 | - Label: 16 | default: AWS Instance and Network Settings 17 | Parameters: 18 | - IndexerInstanceType 19 | - SearchHeadInstanceType 20 | - KeyName 21 | - WebClientLocation 22 | - HECClientLocation 23 | - SSHClientLocation 24 | - VPCID 25 | - VPCCIDR 26 | - PublicSubnet1ID 27 | - PublicSubnet2ID 28 | - PublicSubnet3ID 29 | - NumberOfAZs 30 | - Label: 31 | default: Splunk Settings 32 | Parameters: 33 | - SplunkAdminPassword 34 | - SplunkClusterSecret 35 | - SplunkIndexerDiscoverySecret 36 | - SplunkLicenseBucket 37 | - SplunkLicensePath 38 | - SplunkIndexerCount 39 | - SplunkIndexerDiskSize 40 | - SplunkSearchHeadDiskSize 41 | - SplunkReplicationFactor 42 | - SplunkSearchFactor 43 | - SHCEnabled 44 | - IndexerApps 45 | - SearchHeadApps 46 | ParameterLabels: 47 | QSS3BucketName: 48 | default: QuickStart S3 Bucket Name 49 | QSS3BucketRegion: 50 | default: Quick Start S3 bucket region 51 | QSS3KeyPrefix: 52 | default: QuickStart S3 Key Prefix 53 | WebClientLocation: 54 | default: Permitted CIDR for Splunk web interface 55 | HECClientLocation: 56 | default: Permitted CIDR for Splunk HTTP event collector input 57 | IndexerInstanceType: 58 | default: EC2 instance type for Splunk indexer 59 | SearchHeadInstanceType: 60 | default: EC2 instance type for Splunk search head 61 | KeyName: 62 | default: Key Name 63 | PublicSubnet1ID: 64 | default: Public Subnet 1 ID 65 | PublicSubnet2ID: 66 | default: Public Subnet 2 ID 67 | PublicSubnet3ID: 68 | default: Public Subnet 3 ID 69 | NumberOfAZs: 70 | default: Number of Availability Zones 71 | SHCEnabled: 72 | default: Enable Search Head Cluster? 73 | SSHClientLocation: 74 | default: Permitted CIDR for ssh 75 | SplunkAdminPassword: 76 | default: Splunk Admin Password 77 | SplunkIndexerCount: 78 | default: No. of Splunk Indexers 79 | SplunkIndexerDiskSize: 80 | default: Indexer Disk Size 81 | SplunkSearchHeadDiskSize: 82 | default: Search Head(s) Disk Size 83 | SplunkLicenseBucket: 84 | default: Splunk License Bucket 85 | SplunkLicensePath: 86 | default: Splunk License S3 Bucket Path 87 | SplunkReplicationFactor: 88 | default: Index Cluster Replication Factor 89 | SplunkSearchFactor: 90 | default: Index Cluster Search Factor 91 | SplunkClusterSecret: 92 | default: Shared Security Key for Cluster Nodes 93 | SplunkIndexerDiscoverySecret: 94 | default: Shared Security Key for Forwarders using Indexer Discovery 95 | IndexerApps: 96 | default: Apps/Add-ons to pre-Install on Splunk Indexers 97 | SearchHeadApps: 98 | default: Apps/Add-ons to pre-Install on Splunk Search Heads 99 | VPCCIDR: 100 | default: VPC CIDR 101 | VPCID: 102 | default: VPC ID 103 | Parameters: 104 | WebClientLocation: 105 | AllowedPattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$ 106 | ConstraintDescription: Must be a valid IP range in x.x.x.x/x notation. Use 0.0.0.0/0 107 | for no restrictions. 108 | Description: 'The IP address range that is allowed to connect to the Splunk web 109 | interface. Note: a value of 0.0.0.0/0 will allow access from ANY ip address' 110 | MaxLength: '19' 111 | MinLength: '9' 112 | Type: String 113 | HECClientLocation: 114 | AllowedPattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$ 115 | ConstraintDescription: Must be a valid IP range in x.x.x.x/x notation. Use 0.0.0.0/0 116 | for no restrictions. 117 | Description: 'The IP address range that is allowed to send data to Splunk HTTP 118 | Event Collector. Note: a value of 0.0.0.0/0 will allow access from ANY ip address' 119 | MaxLength: '19' 120 | MinLength: '9' 121 | Type: String 122 | IndexerInstanceType: 123 | AllowedValues: 124 | - c4.2xlarge 125 | - c4.4xlarge 126 | - c4.8xlarge 127 | - m4.2xlarge 128 | - m4.4xlarge 129 | - m4.10xlarge 130 | - c5.2xlarge 131 | - c5.4xlarge 132 | - c5.9xlarge 133 | - c5.18xlarge 134 | - i3.2xlarge 135 | - i3.4xlarge 136 | - i3.8xlarge 137 | Description: EC2 instance type for Splunk Indexers 138 | ConstraintDescription: must be a valid EC2 instance type. 139 | Default: c5.4xlarge 140 | Type: String 141 | SearchHeadInstanceType: 142 | AllowedValues: 143 | - c4.2xlarge 144 | - c4.4xlarge 145 | - c4.8xlarge 146 | - r4.4xlarge 147 | - r4.8xlarge 148 | - r4.16xlarge 149 | - c5.2xlarge 150 | - c5.4xlarge 151 | - c5.9xlarge 152 | - m5.2xlarge 153 | - m5.4xlarge 154 | - m5.12xlarge 155 | Description: EC2 instance type for Splunk Search Heads 156 | ConstraintDescription: must be a valid EC2 instance type. 157 | Default: c5.4xlarge 158 | Type: String 159 | IndexerApps: 160 | Description: Comma separated list of URLs of Splunk App (or Add-on) tarballs (.spl) 161 | to pre-install on indexer(s) 162 | Default: '' 163 | Type: CommaDelimitedList 164 | SearchHeadApps: 165 | Description: Comma separated list of URLs of Splunk App (or Add-on) tarballs (.spl) 166 | to pre-install on search head(s) 167 | Default: '' 168 | Type: CommaDelimitedList 169 | KeyName: 170 | ConstraintDescription: Must be the name of an existing EC2 KeyPair. 171 | Description: Name of an existing EC2 KeyPair to enable SSH access to the instance 172 | Type: AWS::EC2::KeyPair::KeyName 173 | NumberOfAZs: 174 | AllowedValues: 175 | - '2' 176 | - '3' 177 | Default: '2' 178 | Description: Number of Availability Zones to use in the VPC. This must match the 179 | number public subnet IDs entered as parameters 180 | Type: String 181 | PublicSubnet1ID: 182 | Description: ID of Splunk public subnet 1 in Availability Zone 1 (e.g., subnet-xxxxxxxx) 183 | Type: AWS::EC2::Subnet::Id 184 | PublicSubnet2ID: 185 | Description: ID of Splunk public subnet 2 in Availability Zone 2 (e.g., subnet-xxxxxxxx) 186 | Type: AWS::EC2::Subnet::Id 187 | PublicSubnet3ID: 188 | Description: ID of Splunk public subnet 3 in Availability Zone 3 (e.g., subnet-xxxxxxxx) 189 | Type: AWS::EC2::Subnet::Id 190 | Default: '' 191 | QSS3BucketName: 192 | Default: splk-quickstart-testing 193 | Description: S3 bucket name for the Quick Start assets. 194 | Type: String 195 | QSS3BucketRegion: 196 | Default: 'us-east-1' 197 | Description: 'The AWS Region where the Quick Start S3 bucket (QSS3BucketName) is hosted. When using your own bucket, you must specify this value.' 198 | Type: String 199 | QSS3KeyPrefix: 200 | Default: quickstart-splunk-enterprise/ 201 | Description: S3 key prefix for the Quick Start assets. 202 | Type: String 203 | SHCEnabled: 204 | AllowedValues: 205 | - 'yes' 206 | - 'no' 207 | Default: 'no' 208 | Description: Do you want to build a Splunk search head cluster? 209 | Type: String 210 | SSHClientLocation: 211 | AllowedPattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$ 212 | ConstraintDescription: Must be a valid IP range in x.x.x.x/x notation. Use 0.0.0.0/0 213 | for no restrictions. 214 | Description: 'The IP address range that is allowed to SSH to the EC2 instances. 215 | Note: a value of 0.0.0.0/0 will allow access from ANY ip address' 216 | MaxLength: '19' 217 | MinLength: '9' 218 | Type: String 219 | SplunkAdminPassword: 220 | AllowedPattern: (?=^.{6,255}$)((?=.*\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[^A-Za-z0-9])(?=.*[a-z])|(?=.*[^A-Za-z0-9])(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9]))^.* 221 | ConstraintDescription: Must be at least 8 characters containing letters, numbers 222 | and symbols. 223 | Description: Admin password for Splunk. Must be at least 6 characters containing 224 | letters, numbers and symbols. 225 | MaxLength: '32' 226 | MinLength: '6' 227 | NoEcho: 'true' 228 | Type: String 229 | SplunkIndexerCount: 230 | ConstraintDescription: must be a valid number, 3-10 231 | Default: '3' 232 | Description: How many Splunk indexers to launch. [3-10] 233 | MaxValue: '10' 234 | MinValue: '3' 235 | Type: Number 236 | SplunkIndexerDiskSize: 237 | ConstraintDescription: must be a valid number, 320-16000 238 | Default: '320' 239 | Description: The size of the attached EBS volume to the Splunk indexers. (in 240 | GB) 241 | MaxValue: '16000' 242 | MinValue: '320' 243 | Type: Number 244 | SplunkSearchHeadDiskSize: 245 | ConstraintDescription: must be a valid number, 320-16000 246 | Default: '320' 247 | Description: The size of the attached EBS volume to the Splunk search head(s). (in 248 | GB) 249 | MaxValue: '16000' 250 | MinValue: '320' 251 | Type: Number 252 | SplunkLicenseBucket: 253 | Default: '' 254 | Description: Name of private S3 bucket with licenses to be accessed via authenticated 255 | requests 256 | Type: String 257 | SplunkLicensePath: 258 | Default: '' 259 | Description: Path to license file in S3 Bucket (without leading '/') 260 | Type: String 261 | SplunkReplicationFactor: 262 | ConstraintDescription: must be a valid number, 2-4 263 | Default: '2' 264 | Description: How many copies of data should be stored in the Splunk Indexer Cluster 265 | MaxValue: '4' 266 | MinValue: '2' 267 | Type: Number 268 | SplunkSearchFactor: 269 | ConstraintDescription: must be a valid number, 2-4 270 | Default: '2' 271 | Description: How many copies of data should be searchable in the Splunk indexer 272 | clusters 273 | MaxValue: '4' 274 | MinValue: '2' 275 | Type: Number 276 | SplunkClusterSecret: 277 | AllowedPattern: (?=^.{6,255}$)((?=.*\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[^A-Za-z0-9])(?=.*[a-z])|(?=.*[^A-Za-z0-9])(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9]))^.* 278 | ConstraintDescription: Must be at least 8 characters containing letters, numbers 279 | and symbols. 280 | Description: Shared cluster secret for Search Head and Indexer cluster nodes. 281 | Must be at least 8 characters containing letters, numbers and symbols. 282 | MaxLength: '32' 283 | MinLength: '8' 284 | NoEcho: 'true' 285 | Type: String 286 | SplunkIndexerDiscoverySecret: 287 | AllowedPattern: (?=^.{6,255}$)((?=.*\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[^A-Za-z0-9])(?=.*[a-z])|(?=.*[^A-Za-z0-9])(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9]))^.* 288 | ConstraintDescription: Must be at least 8 characters containing letters, numbers 289 | and symbols. 290 | Description: >- 291 | Security key used for communication between your forwarders and the cluster 292 | master. This value should also be used by forwarders in order to retrieve list 293 | of available peer nodes from cluster master. Must be at least 8 characters containing 294 | letters, numbers and symbols. 295 | MaxLength: '32' 296 | MinLength: '8' 297 | NoEcho: 'true' 298 | Type: String 299 | VPCCIDR: 300 | AllowedPattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$ 301 | ConstraintDescription: must be a valid IP CIDR range of the form x.x.x.x/x. 302 | Description: VPC CIDR Block (x.x.x.x/x notation) 303 | Type: String 304 | VPCID: 305 | Description: VPC ID 306 | Type: AWS::EC2::VPC::Id 307 | Conditions: 308 | Create3AZ: !Equals 309 | - !Ref 'NumberOfAZs' 310 | - '3' 311 | CreateSingleSearchHead: !Equals 312 | - !Ref 'SHCEnabled' 313 | - 'no' 314 | CreateSHC: !Equals 315 | - !Ref 'SHCEnabled' 316 | - 'yes' 317 | InstallIndexerApps: !Not 318 | - !Equals 319 | - !Join 320 | - '' 321 | - !Ref 'IndexerApps' 322 | - '' 323 | InstallSearchHeadApps: !Not 324 | - !Equals 325 | - !Join 326 | - '' 327 | - !Ref 'SearchHeadApps' 328 | - '' 329 | ConfigureLicense: !And 330 | - !Not 331 | - !Equals 332 | - '' 333 | - !Ref 'SplunkLicenseBucket' 334 | - !Not 335 | - !Equals 336 | - '' 337 | - !Ref 'SplunkLicensePath' 338 | UsingDefaultBucket: !Equals [!Ref QSS3BucketName, 'aws-quickstart'] 339 | Mappings: 340 | AWSAMIRegionMap: 341 | AMI: 342 | SPLUNKENTHVM: splunk_marketplace_AMI_2018-10-16_22_07_36-7b65de6c-5006-4ca2-bd75-fdba95ae5d9d-ami-0d494b5a999e1c49f.4 343 | ap-northeast-1: 344 | SPLUNKENTHVM: ami-0db36f11d65f551fb 345 | ap-northeast-2: 346 | SPLUNKENTHVM: ami-09c7965888207979b 347 | ap-south-1: 348 | SPLUNKENTHVM: ami-07c20db6edfd45f98 349 | ap-southeast-1: 350 | SPLUNKENTHVM: ami-0e7b7ca1bdcdd93a6 351 | ap-southeast-2: 352 | SPLUNKENTHVM: ami-0c8a4d5bdf83f0df8 353 | ca-central-1: 354 | SPLUNKENTHVM: ami-02f085f4514fa7145 355 | eu-central-1: 356 | SPLUNKENTHVM: ami-09ce965c3b1a9a1cb 357 | eu-west-1: 358 | SPLUNKENTHVM: ami-0fafe9e81915f154e 359 | eu-west-2: 360 | SPLUNKENTHVM: ami-060d9e50d310e0ebb 361 | sa-east-1: 362 | SPLUNKENTHVM: ami-0dacd4005280936e5 363 | us-east-1: 364 | SPLUNKENTHVM: ami-0484972f36720ea7f 365 | us-east-2: 366 | SPLUNKENTHVM: ami-04b6874c649721f0a 367 | us-west-1: 368 | SPLUNKENTHVM: ami-0377011a3f771e353 369 | us-west-2: 370 | SPLUNKENTHVM: ami-0c3e33232b6c07537 371 | SplunkConfig: 372 | dedicated-instance-type: 373 | clusterMaster: c5.xlarge 374 | shclusterDeployer: c5.xlarge 375 | shcluster-replication-factor: 376 | num: '3' 377 | labels: 378 | cluster: IndexerCluster 379 | shcluster: SearchHeadCluster 380 | Resources: 381 | SplunkSearchHeadSecurityGroup: 382 | Type: AWS::EC2::SecurityGroup 383 | Properties: 384 | VpcId: !Ref 'VPCID' 385 | GroupDescription: Enable port 8000 for Splunk web interface, port 8090 for SHC 386 | replication, and port 8191 for KV store replication 387 | SecurityGroupIngress: 388 | - IpProtocol: tcp 389 | FromPort: 8000 390 | ToPort: 8000 391 | CidrIp: !Ref 'WebClientLocation' 392 | - IpProtocol: tcp 393 | FromPort: 8090 394 | ToPort: 8090 395 | CidrIp: !Ref 'VPCCIDR' 396 | - IpProtocol: tcp 397 | FromPort: 8191 398 | ToPort: 8191 399 | CidrIp: !Ref 'VPCCIDR' 400 | Tags: 401 | - Key: Application 402 | Value: !Ref 'AWS::StackId' 403 | - Key: Name 404 | Value: SplunkSearchHeadSecurityGroup 405 | SplunkIndexerSecurityGroup: 406 | Type: AWS::EC2::SecurityGroup 407 | Properties: 408 | VpcId: !Ref 'VPCID' 409 | GroupDescription: Enable port 9997 for splunktcp input, port 8088 for HEC input, 410 | port 514 for tcp/udp input, and port 9887 for data replication 411 | SecurityGroupIngress: 412 | - IpProtocol: tcp 413 | FromPort: 9997 414 | ToPort: 9997 415 | CidrIp: !Ref 'VPCCIDR' 416 | - IpProtocol: tcp 417 | FromPort: 8088 418 | ToPort: 8088 419 | SourceSecurityGroupId: !Ref 'SplunkHttpEventCollectorLoadBalancerSecurityGroup' 420 | - IpProtocol: tcp 421 | FromPort: 514 422 | ToPort: 514 423 | CidrIp: !Ref 'VPCCIDR' 424 | - IpProtocol: udp 425 | FromPort: 514 426 | ToPort: 514 427 | CidrIp: !Ref 'VPCCIDR' 428 | - IpProtocol: tcp 429 | FromPort: 9887 430 | ToPort: 9887 431 | CidrIp: !Ref 'VPCCIDR' 432 | Tags: 433 | - Key: Application 434 | Value: !Ref 'AWS::StackId' 435 | - Key: Name 436 | Value: SplunkIndexerSecurityGroup 437 | SplunkSecurityGroup: 438 | Type: AWS::EC2::SecurityGroup 439 | Properties: 440 | VpcId: !Ref 'VPCID' 441 | GroupDescription: Enable administrative ports like restricted SSH and management 442 | port 443 | SecurityGroupIngress: 444 | - IpProtocol: tcp 445 | FromPort: 22 446 | ToPort: 22 447 | CidrIp: !Ref 'SSHClientLocation' 448 | - IpProtocol: tcp 449 | FromPort: 8089 450 | ToPort: 8089 451 | CidrIp: !Ref 'VPCCIDR' 452 | Tags: 453 | - Key: Application 454 | Value: !Ref 'AWS::StackId' 455 | - Key: Name 456 | Value: SplunkSecurityGroup 457 | SplunkHttpEventCollectorLoadBalancerSecurityGroup: 458 | Type: AWS::EC2::SecurityGroup 459 | Properties: 460 | VpcId: !Ref 'VPCID' 461 | GroupDescription: Enable port 8088 on ELB for HEC input 462 | SecurityGroupIngress: 463 | - IpProtocol: tcp 464 | FromPort: 8088 465 | ToPort: 8088 466 | CidrIp: !Ref 'HECClientLocation' 467 | Tags: 468 | - Key: Application 469 | Value: !Ref 'AWS::StackId' 470 | - Key: Name 471 | Value: SplunkHttpEventCollectorLoadBalancerSecurityGroup 472 | SplunkSearchHeadInstance: 473 | Type: AWS::EC2::Instance 474 | Condition: CreateSingleSearchHead 475 | CreationPolicy: 476 | ResourceSignal: 477 | Timeout: PT60M 478 | Properties: 479 | ImageId: !FindInMap 480 | - AWSAMIRegionMap 481 | - !Ref 'AWS::Region' 482 | - SPLUNKENTHVM 483 | InstanceType: !Ref 'SearchHeadInstanceType' 484 | KeyName: !Ref 'KeyName' 485 | Tags: 486 | - Key: Application 487 | Value: !Ref 'AWS::StackId' 488 | - Key: Role 489 | Value: splunk-search-head 490 | - Key: Name 491 | Value: search-head 492 | NetworkInterfaces: 493 | - GroupSet: 494 | - !Ref 'SplunkSecurityGroup' 495 | - !Ref 'SplunkSearchHeadSecurityGroup' 496 | AssociatePublicIpAddress: true 497 | DeviceIndex: '0' 498 | DeleteOnTermination: true 499 | SubnetId: !Ref 'PublicSubnet1ID' 500 | BlockDeviceMappings: 501 | - DeviceName: /dev/xvda 502 | Ebs: 503 | VolumeType: gp2 504 | VolumeSize: !Ref 'SplunkSearchHeadDiskSize' 505 | UserData: !Base64 506 | Fn::Join: 507 | - '' 508 | - - "#!/bin/bash -v\n" 509 | - "# First make cloud-init output log readable by root only to protect\ 510 | \ sensitive parameter values\n" 511 | - "chmod 600 /var/log/cloud-init-output.log\n" 512 | - "yum update -y aws-cfn-bootstrap\n" 513 | - "export LOCALIP=$(curl -s http://169.254.169.254/latest/meta-data/local-ipv4)\n" 514 | - "export INSTANCEID=$(curl -s http://169.254.169.254/latest/meta-data/instance-id)\n" 515 | - "export SPLUNK_USER=splunk\n" 516 | - "export SPLUNK_BIN=/opt/splunk/bin/splunk\n" 517 | - "export SPLUNK_HOME=/opt/splunk\n" 518 | - "printf '%s\t%s\n' \"$LOCALIP\" 'splunksearch' >> /etc/hosts\n" 519 | - "hostname splunksearch\n" 520 | - "mv $SPLUNK_HOME/etc/passwd $SPLUNK_HOME/etc/passwd.bak\n" 521 | - "cat >>$SPLUNK_HOME/etc/system/local/user-seed.conf <>$SPLUNK_HOME/etc/apps/base-autogenerated/local/web.conf <>$SPLUNK_HOME/etc/apps/base-autogenerated/local/outputs.conf </dev/null)\n" 684 | - "export SPLUNK_USER=splunk\n" 685 | - "export SPLUNK_BIN=/opt/splunk/bin/splunk\n" 686 | - "export SPLUNK_HOME=/opt/splunk\n" 687 | - "# remove stale splunkd.log that ships with AMI.\n" 688 | - "rm -f $SPLUNK_HOME/var/log/splunk/splunkd.log\n" 689 | - "printf '%s\t%s\n' \"$LOCALIP\" 'splunklicense' >> /etc/hosts\n" 690 | - "hostname splunklicense\n" 691 | - "mv $SPLUNK_HOME/etc/passwd $SPLUNK_HOME/etc/passwd.bak\n" 692 | - "cat >>$SPLUNK_HOME/etc/system/local/user-seed.conf <>$SPLUNK_HOME/etc/apps/base-autogenerated/local/web.conf <>$SPLUNK_HOME/etc/apps/base-autogenerated/local/outputs.conf <>$SPLUNK_HOME/etc/system/local/server.conf < /tmp/token\n" 781 | - "TOKEN=`sed -n 's/\\ttoken=//p' /tmp/token` && rm /tmp/token\n" 782 | - "echo $TOKEN\n" 783 | - "mkdir -p $SPLUNK_HOME/etc/master-apps/peer-base-autogenerated/local\n" 784 | - "mv $SPLUNK_HOME/etc/apps/splunk_httpinput/local/inputs.conf $SPLUNK_HOME/etc/master-apps/peer-base-autogenerated/local\n" 785 | - "# Peer config 2: Enable splunktcp input\n" 786 | - "cat >>$SPLUNK_HOME/etc/master-apps/peer-base-autogenerated/local/inputs.conf\ 787 | \ <> /etc/hosts\n" 887 | - "hostname splunk-shc-deployer\n" 888 | - "mv $SPLUNK_HOME/etc/passwd $SPLUNK_HOME/etc/passwd.bak\n" 889 | - "cat >>$SPLUNK_HOME/etc/system/local/user-seed.conf <>$SPLUNK_HOME/etc/apps/base-autogenerated/local/web.conf <>$SPLUNK_HOME/etc/apps/base-autogenerated/local/server.conf <>$SPLUNK_HOME/etc/apps/base-autogenerated/local/outputs.conf <>$SPLUNK_HOME/etc/shcluster/apps/member-base-autogenerated/local/outputs.conf\ 941 | \ <> /etc/hosts\n" 1053 | - "hostname splunksearch\n" 1054 | - "mv $SPLUNK_HOME/etc/passwd $SPLUNK_HOME/etc/passwd.bak\n" 1055 | - "cat >>$SPLUNK_HOME/etc/system/local/user-seed.conf <$SPLUNK_HOME/etc/system/local/web.conf <>$SPLUNK_HOME/etc/system/local/server.conf <> /etc/hosts\n" 1166 | - "hostname splunksearch\n" 1167 | - "mv $SPLUNK_HOME/etc/passwd $SPLUNK_HOME/etc/passwd.bak\n" 1168 | - "cat >>$SPLUNK_HOME/etc/system/local/user-seed.conf <$SPLUNK_HOME/etc/system/local/web.conf <>$SPLUNK_HOME/etc/system/local/server.conf <> /etc/hosts\n" 1282 | - "hostname splunksearch\n" 1283 | - "mv $SPLUNK_HOME/etc/passwd $SPLUNK_HOME/etc/passwd.bak\n" 1284 | - "cat >>$SPLUNK_HOME/etc/system/local/user-seed.conf <$SPLUNK_HOME/etc/system/local/web.conf <>$SPLUNK_HOME/etc/system/local/server.conf <>$SPLUNK_HOME/etc/system/local/user-seed.conf <>$SPLUNK_HOME/etc/apps/base-autogenerated/local/web.conf <>$SPLUNK_HOME/etc/apps/base-autogenerated/local/server.conf <