mirror of
https://github.com/ZwareBear/JFrog-Cloud-Installers.git
synced 2026-01-21 23:07:49 -06:00
Checking in code for rt 7.27.10 and xray 3.35.0 version
This commit is contained in:
Giridharan Ramasamy
@@ -0,0 +1,27 @@
|
||||
// Change the following attributes.
|
||||
:quickstart-project-name: quickstart-documentation-base
|
||||
:partner-product-name: Example Product Name
|
||||
// For the following attribute, if you have no short name, enter the same name as partner-product-name.
|
||||
:partner-product-short-name: Example Product Name
|
||||
// If there's no partner, comment partner-company-name.
|
||||
:partner-company-name: Example Company Name, Ltd.
|
||||
:doc-month: Month of launch or significant update (spelled out)
|
||||
:doc-year: Year
|
||||
// Uncomment the following "contributor" attributes as appropriate. If the partner agrees to include names, enter contributor names for every line we use. If partner doesn't want to include names, delete all placeholder names and keep only "{partner-company-name}" and "AWS Quick Start team."
|
||||
//:partner-contributors: Shuai Ye, Michael McConnell, and John Smith, {partner-company-name}
|
||||
//:other-contributors: Akua Mansa, Trek10
|
||||
//:aws-contributors: Janine Singh, AWS IoT Partner team
|
||||
:quickstart-contributors: Toni Jones, AWS Quick Start team
|
||||
// For deployment_time, use minutes if deployment takes an hour or less,
|
||||
// for example, 30 minutes or 60 minutes.
|
||||
// Use hours for deployment times greater than 60 minutes (rounded to a quarter hour),
|
||||
// for example, 1.25 hours, 2 hours, 2.5 hours.
|
||||
:deployment_time: 15 minutes / 60 minutes / 1.5 hours
|
||||
:default_deployment_region: us-east-1
|
||||
:parameters_as_appendix:
|
||||
// Uncomment the following two attributes if you are using an AWS Marketplace listing.
|
||||
// Additional content will be generated automatically based on these attributes.
|
||||
// :marketplace_subscription:
|
||||
// :marketplace_listing_url: https://example.com/
|
||||
// Uncomment the following attribute to add a statement about AWS and our stance on compliance-related Quick Starts.
|
||||
// :compliance-statement: Deploying this Quick Start does not guarantee an organization’s compliance with any laws, certifications, policies, or other regulations.
|
||||
@@ -0,0 +1,23 @@
|
||||
// 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.
|
||||
//Should any sections not be applicable, remove them
|
||||
|
||||
== Test the deployment
|
||||
// If steps are required to test the deployment, add them here. If not, remove the heading
|
||||
|
||||
== Post-deployment steps
|
||||
// If post-deployment steps are required, add them here. If not, remove the heading
|
||||
|
||||
== Best practices for using {partner-product-short-name} on AWS
|
||||
// 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.
|
||||
|
||||
_Add any best practices for using the software._
|
||||
|
||||
== Security
|
||||
// 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.
|
||||
|
||||
_Add any security-related information._
|
||||
|
||||
== Other useful information
|
||||
//Provide any other information of interest to users, especially focusing on areas where AWS or cloud usage differs from on-premises usage.
|
||||
|
||||
_Add any other details that will help the customer use the software on AWS._
|
||||
@@ -0,0 +1,29 @@
|
||||
:xrefstyle: short
|
||||
|
||||
Deploying this Quick Start for a new virtual private cloud (VPC) with
|
||||
default parameters builds the following {partner-product-short-name} environment in the
|
||||
AWS Cloud.
|
||||
|
||||
// Replace this example diagram with your own. Follow our wiki guidelines: https://w.amazon.com/bin/view/AWS_Quick_Starts/Process_for_PSAs/#HPrepareyourarchitecturediagram. Upload your source PowerPoint file to the GitHub {deployment name}/docs/images/ directory in this repo.
|
||||
|
||||
[#architecture1]
|
||||
.Quick Start architecture for {partner-product-short-name} on AWS
|
||||
image::../images/architecture_diagram.png[Architecture]
|
||||
|
||||
As shown in <<architecture1>>, 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:
|
||||
** <item>.
|
||||
** <item>.
|
||||
// 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. End each bullet with a period.
|
||||
* <describe any additional components>.
|
||||
|
||||
[.small]#* 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.#
|
||||
@@ -0,0 +1,44 @@
|
||||
// We need to work around Step numbers here if we are going to potentially exclude the AMI subscription
|
||||
=== 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 link:#_planning_the_deployment[Planning the deployment] earlier in this guide.
|
||||
. Make sure that your AWS account is configured correctly, as discussed in the link:#_technical_requirements[Technical requirements] section.
|
||||
|
||||
// Optional based on Marketplace listing. Not to be edited
|
||||
ifdef::marketplace_subscription[]
|
||||
=== Subscribe to the {partner-product-short-name} AMI
|
||||
|
||||
This Quick Start requires a subscription to the AMI for {partner-product-short-name} in AWS Marketplace.
|
||||
|
||||
. Sign in to your AWS account.
|
||||
. Open the page for the {marketplace_listing_url}[{partner-product-short-name} AMI in AWS Marketplace^], and then choose *Continue to Subscribe*.
|
||||
. Review the terms and conditions for software usage, and then choose *Accept Terms*. +
|
||||
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^].
|
||||
|
||||
. 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.
|
||||
endif::marketplace_subscription[]
|
||||
// \Not to be edited
|
||||
|
||||
=== Launch the Quick Start
|
||||
// Adapt the following warning to your Quick Start.
|
||||
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. Also make sure that the domain name option in the DHCP options is configured as explained in http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html[DHCP options sets^]. You provide your VPC settings when you launch the Quick Start.
|
||||
|
||||
Each deployment takes about {deployment_time} to complete.
|
||||
|
||||
. 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.
|
||||
|
||||
[cols="3,1"]
|
||||
|===
|
||||
^|http://qs_launch_permalink[Deploy {partner-product-short-name} into a new VPC on AWS^]
|
||||
^|http://qs_template_permalink[View template^]
|
||||
|
||||
^|http://qs_launch_permalink[Deploy {partner-product-short-name} into an existing VPC on AWS^]
|
||||
^|http://qs_template_permalink[View template^]
|
||||
|===
|
||||
|
||||
[start=2]
|
||||
. Check the AWS Region that’s displayed in the upper-right corner of the navigation bar, and change it if necessary. This Region is where the network infrastructure for {partner-product-short-name} is built. The template is launched in the {default_deployment_region} Region by default. For other choices, see link:#_supported_regions[Supported Regions] earlier in this guide.
|
||||
|
||||
[start=3]
|
||||
. 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. For details on each parameter, see the link:#_parameter_reference[Parameter reference] section of this guide. When you finish reviewing and customizing the parameters, choose *Next*.
|
||||
@@ -0,0 +1,8 @@
|
||||
// Edit this placeholder text to accurately describe your architecture.
|
||||
|
||||
This Quick Start provides two deployment options:
|
||||
|
||||
* *Deploy {partner-product-short-name} into a new VPC*. 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.
|
||||
* *Deploy {partner-product-short-name} into an existing VPC*. This option provisions {partner-product-short-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 {partner-product-short-name} settings, as discussed later in this guide.
|
||||
@@ -0,0 +1,21 @@
|
||||
// Add any tips or answers to anticipated questions.
|
||||
|
||||
== FAQ
|
||||
|
||||
*Q.* I encountered a *CREATE_FAILED* error when I launched the Quick Start.
|
||||
|
||||
*A.* If AWS CloudFormation fails to create the stack, relaunch the template with *Rollback on failure* set to *Disabled*. This setting is under *Advanced* in the AWS CloudFormation console on the *Configure stack options* page. With this setting, the stack’s state is retained, and the instance keeps running so that you can troubleshoot the issue. (For Windows, look at the log files in `%ProgramFiles%\Amazon\EC2ConfigService` and `C:\cfn\log`.)
|
||||
// Customize this answer if needed. For example, if you’re deploying on Linux instances, either provide the location for log files on Linux or omit the final sentence. If the Quick Start has no EC2 instances, revise accordingly (something like "and the assets keep running").
|
||||
|
||||
WARNING: When you set *Rollback on failure* to *Disabled*, you continue to incur AWS charges for this stack. Delete the stack when you finish troubleshooting.
|
||||
|
||||
For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html[Troubleshooting AWS CloudFormation^].
|
||||
|
||||
*Q.* I encountered a size-limitation error when I deployed the AWS CloudFormation templates.
|
||||
|
||||
*A.* 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, see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html[AWS CloudFormation quotas^].
|
||||
|
||||
|
||||
== Troubleshooting
|
||||
|
||||
<Steps for troubleshooting the deployment.>
|
||||
@@ -0,0 +1,12 @@
|
||||
// Include details about any licenses and how to sign up. Provide links as appropriate. If no licenses are required, clarify that. The following paragraphs provide examples of details you can provide. Remove italics, and rephrase as appropriate.
|
||||
|
||||
_<Example 1>No licenses are required to deploy this Quick Start. All AWS service resources consumed during the launch of the Quick Start incur AWS service usage costs._
|
||||
|
||||
_<Example 2>Some configurations of the {partner-product-short-name} Quick Start involve the use of third-party software. You are responsible for obtaining a license directly from the software vendor._
|
||||
|
||||
_<Example 3>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 <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>._
|
||||
|
||||
// Or, if the deployment uses an AMI, update this paragraph. If it doesn’t, remove the paragraph.
|
||||
_<AMI information>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._
|
||||
@@ -0,0 +1,7 @@
|
||||
// Replace the content in <>
|
||||
// Identify your target audience and explain how/why they would use this Quick Start.
|
||||
//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.
|
||||
|
||||
This guide provides instructions for deploying the {partner-product-short-name} Quick Start reference architecture on the AWS Cloud.
|
||||
|
||||
This Quick Start is for users who <target audience and usage scenario>
|
||||
@@ -0,0 +1,13 @@
|
||||
// If no preperation is required, remove all content from here
|
||||
|
||||
==== Prepare your AWS account
|
||||
|
||||
_Describe any setup required in the AWS account prior to template launch_
|
||||
|
||||
==== Prepare your {partner-company-name} 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_
|
||||
@@ -0,0 +1,5 @@
|
||||
// Replace the content in <>
|
||||
// Briefly describe the software. Use consistent and clear branding.
|
||||
// Include the benefits of using the software on AWS, and provide details on usage scenarios.
|
||||
|
||||
<Describe how the software works on AWS.>
|
||||
@@ -0,0 +1,6 @@
|
||||
This Quick Start supports the following Regions:
|
||||
|
||||
* us-east-1, US East (N. Virginia) (EXAMPLE)
|
||||
* us-east-2, US East (Ohio) (EXAMPLE)
|
||||
|
||||
//Full list: https://docs.aws.amazon.com/general/latest/gr/rande.html
|
||||
@@ -0,0 +1,14 @@
|
||||
// Replace the <n> in each row to specify the number of resources used in this deployment. Remove the rows for resources that aren’t used.
|
||||
|===
|
||||
|Resource |This deployment uses
|
||||
|
||||
// Space needed to maintain table headers
|
||||
|VPCs |<n>
|
||||
|Elastic IP addresses |<n>
|
||||
|Security groups |<n>
|
||||
|AWS Identity and Access Management (IAM) roles |<n>
|
||||
|Auto Scaling groups |<n>
|
||||
|Application Load Balancers |<n>
|
||||
|Network Load Balancers |<n>
|
||||
|<type> instances |<n>
|
||||
|===
|
||||
@@ -0,0 +1,6 @@
|
||||
// Replace the content in <>
|
||||
// For example: “familiarity with basic concepts in networking, database operations, and data encryption” or “familiarity with <software>.”
|
||||
// Include links if helpful.
|
||||
// You don't need to list AWS services or point to general info about AWS; the boilerplate already covers this.
|
||||
|
||||
This Quick Start also assumes familiarity with <knowledge expectations specific to this Quick Start>.
|
||||
Reference in New Issue
Block a user