:parameters_as_appendix:
[.text-center]
[discrete]
== {partner-product-name}
:doctitle: {partner-product-name}
:!toc:
[.text-left]
include::../{includedir}/introduction.adoc[]
== Overview
include::../{includedir}/overview.adoc[]
ifndef::disable_licenses[]
== AWS costs
include::../{includedir}/cost.adoc[]
== Software licenses
ifndef::production_build[]
_**This portion of the deployment guide is located in `docs/{specificdir}/licenses.adoc`**_
[.preview_mode]
|===
a|
endif::production_build[]
include::../{specificdir}/licenses.adoc[]
ifndef::production_build[]
|===
endif::production_build[]
endif::disable_licenses[]
== Architecture
Deploying this Quick Start with default parameters into an existing Amazon EKS cluster builds the following environment. For a diagram of the new virtual private cloud (VPC) and Amazon EKS cluster, see https://aws-quickstart.github.io/quickstart-amazon-eks/[Amazon EKS on the AWS Cloud^].
[#architecture1]
.Quick Start architecture for _{partner-product-name}_
[link=images/architecture_diagram.png]
image::../images/architecture_diagram.png[Architecture]
As shown in Figure 1, the Quick Start sets up the following:
ifndef::production_build[]
_**This portion of the deployment guide is located in `docs/{specificdir}/architecture.adoc`**_
[.preview_mode]
|===
a|
endif::production_build[]
include::../{specificdir}/architecture.adoc[]
ifndef::production_build[]
|===
endif::production_build[]
== Planning the deployment
include::../{includedir}/planning_deployment_eks_module.adoc[]
== Deployment steps
include::../{includedir}/deployment_steps_eks_module.adoc[]
ifndef::production_build[]
_**This portion of the deployment guide is located in `docs/{specificdir}/additional_info.adoc`**_
++++
++++
endif::production_build[]
include::../{specificdir}/additional_info.adoc[]
ifndef::production_build[]
_**This portion of the deployment guide is located in `docs/{specificdir}/faq_troubleshooting.adoc`**_
++++
++++
endif::production_build[]
include::../{specificdir}/faq_troubleshooting.adoc[]
ifndef::production_build[]
++++
++++
endif::production_build[]
== Customer responsibility
After you successfully deploy this Quick Start, confirm that your resources and services are updated and configured — including any required patches — to meet your security and other needs. For more information, see the https://aws.amazon.com/compliance/shared-responsibility-model/[AWS Shared Responsibility Model^].
== Parameter reference
NOTE: Unless you are customizing the Quick Start templates for your own deployment projects, keep the default settings for the parameters labeled *Quick Start S3 bucket name*, *Quick Start S3 bucket Region*, and *Quick Start S3 key prefix*. Changing these parameter settings automatically updates code references to point to a new Quick Start location. For more information, see the https://aws-quickstart.github.io/option1.html[AWS Quick Start Contributor’s Guide^].
=== Deploy into a new VPC and new Amazon EKS cluster
The full list of parameters for this entrypoint are documented in https://aws-quickstart.github.io/quickstart-amazon-eks/#_launch_into_a_new_vpc[Amazon EKS on the AWS Cloud^].
=== Deploy into a new Amazon EKS cluster in an existing VPC
The full list of parameters for this entrypoint are documented in https://aws-quickstart.github.io/quickstart-amazon-eks/#_launch_into_an_existing_vpc[Amazon EKS on the AWS Cloud^].
include::../{generateddir}/parameters/index.adoc[]
== Send us feedback
To post feedback, submit feature ideas, or report bugs, use the *Issues* section of the https://github.com/aws-quickstart/{quickstart-project-name}[GitHub repository^] for this Quick Start. If you want to submit code, review the https://aws-quickstart.github.io/[Quick Start Contributor’s Guide^].
== Quick Start reference deployments
See the https://aws.amazon.com/quickstart/[AWS Quick Start home page^].
== GitHub repository
See the https://github.com/aws-quickstart/{quickstart-project-name}[GitHub repository^] to download
the templates and scripts for this Quick Start, post comments,
and share customizations with others.
'''
include::../{includedir}/disclaimer.adoc[]