Merge pull request #3 from aws-ia/html-guide

Generated deployment guide
aws-ia · Oct 3, 2023 · 85ed328 · 85ed328
2 parents 272fc96 + 6c7094e
commit 85ed328
Show file tree

Hide file tree

Showing 56 changed files with 9,953 additions and 252 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,11 @@
 [submodule "docs/boilerplate"]
  path = docs/boilerplate
  url = https://github.com/aws-ia/aws-ia-documentation-base-common.git
+[submodule "submodules/cfn-ps-aws-vpc"]
+ path = submodules/cfn-ps-aws-vpc
+ url = git@github.com:aws-ia/cfn-ps-aws-vpc.git
+ branch = main
+[submodule "submodules/cfn-ps-aws-acm-certificate"]
+ path = submodules/cfn-ps-aws-acm-certificate
+ url = git@github.com:aws-ia/cfn-ps-aws-acm-certificate.git
+ branch = main
diff --git a/.project_automation/functional_tests/entrypoint.sh b/.project_automation/functional_tests/entrypoint.sh
@@ -22,15 +22,15 @@ if echo "${DIFF_OUTPUT}" | grep "^diff --git a/docs/"; then
  asciidoctor --base-dir docs/ --backend=html5 -o ../index.html -w --doctype=book -a toc2 -a production_build docs/boilerplate/index_deployment_guide.adoc
  ## Create PR with index.html file
  CURRENT_BRANCH=$(git branch --show-current)
- git checkout main
+ # git checkout main
  git checkout -b "${DOCS_BRANCH}"
  git add index.html
  git commit -m '(automated) rendered html deployment guide'
  git push --set-upstream origin "${DOCS_BRANCH}"
  gh pr create --title 'Generated deployment guide' --body "_This is an automated PR with rendered html file for the deployment guide. Please review it before merge_"
 else
  printf '\nNo changes detected in the /docs files. \n'
-fi 
+fi
 
 ##----------------------------------------------------
 ## Download taskcat overrides from AWS Secrets Manager

diff --git a/.project_automation/static_tests/Dockerfile b/.project_automation/static_tests/Dockerfile
@@ -1,4 +1,4 @@
 FROM public.ecr.aws/codebuild/amazonlinux2-x86_64-standard:4.0
 RUN git clone https://github.com/aws-quickstart/qs-cfn-lint-rules.git /tmp/qs-cfn-lint-rules
-RUN cd /tmp/qs-cfn-lint-rules && pip install .
-RUN cfn-lint -u
+RUN cd /tmp/qs-cfn-lint-rules && git checkout 8268db9df3407ccf5383def635bc22e0f99d6b39 && pip install .
+#RUN cfn-lint -u
diff --git a/.project_automation/static_tests/entrypoint.sh b/.project_automation/static_tests/entrypoint.sh
@@ -6,4 +6,11 @@ PROJECT_PATH=${BASE_PATH}/project
 PROJECT_TYPE_PATH=${BASE_PATH}/projecttype
 
 cd $PROJECT_PATH
-cfn-lint --non-zero-exit-code none -t templates/**/*.yaml -a /tmp/qs-cfn-lint-rules/qs_cfn_lint_rules/
+
+# Ignoring the following for migration
+# All warnings,
+# E1019 - Sub validation - false positive for conditionals,
+# E2521 - required properties, E3002 - resource properties - false positive for newer resources than pinned CloudFormation resource spec
+# E3005 - DependsOn - false positive for conditionals,
+# E9101 - Inclusive language check - false positive for database resources
+cfn-lint --ignore-checks W,E1019,E2521,E3002,E3005,E9101 -t templates/**/*.yaml -a /tmp/qs-cfn-lint-rules/qs_cfn_lint_rules/
diff --git a/.taskcat.yml b/.taskcat.yml
@@ -1,33 +1,56 @@
 project:
- name: cfn-sample-template
- owner: quickstart@amazon.com
- package_lambda: false
+ name: cfn-ps-uipath-orchestrator
+ parameters:
+ QSS3KeyPrefix: "quickstart-uipath-orchestrator/"
+ QSS3BucketName: "$[taskcat_autobucket]"
+ QSS3BucketRegion: "$[taskcat_current_region]"
+ HAAPassword: "$[taskcat_genpass_8]"
+ OrchestratorPassword: "$[taskcat_genpass_8]"
+ RDSUsername: "$[taskcat_random-string]"
+ RDSPassword: "$[taskcat_genpass_8]"
+ RDSDBName: "$[taskcat_random-string]"
+ GatewayName: "$[taskcat_random-string]"
+ HAAUser: admin@shivansh.dev
+ HostedZoneID: Z03411186LX2V3ZE3N4K
+ KeyPairName: sshvans
+ BastionIngressCIDR: 10.0.0.0/0
  regions:
  - ap-northeast-1
  - ap-northeast-2
- - ap-southeast-1
- - ap-southeast-2
+ - ap-south-1
+ - ap-east-1
+ - ca-central-1
  - eu-central-1
  - eu-west-1
+ - eu-west-2
+ - eu-west-3
+ - me-south-1
  - sa-east-1
  - us-east-1
+ - us-east-2
  - us-west-1
  - us-west-2
+ shorten_stack_name: true
+ s3_regional_buckets: true
+ package_lambda: false
 tests:
- sample:
- parameters:
- Param1: 'Inputs to Stack'
- # Examples: of other taskcat dynamic input parameters for more into see http://taskcat.io
- #
- # AvailabilityZones: $[taskcat_genaz_3]
- # ByteValue: 1
- # PasswordA: $[taskcat_genpass_8A]
- # PasswordB: $[taskcat_genpass_32S]
- # RandomNumber: $[taskcat_random-numbers]
- # RandomString: $[taskcat_random-string]
- # StackName: TestStack
- # UUID: $[taskcat_genuuid]
- #
+ default-orchestrator:
+ template: ./templates/main.template.yaml
  regions:
- - us-east-2
- template: templates/another-workload.template.yaml
+ - us-west-2
+ s3_bucket: ''
+ parameters:
+ AvailabilityZones: "$[taskcat_getaz_2]"
+ UiPathFQDN: test.shivansh.dev #testone.uipathmarketplace.net
+
+ # existing-vpc:
+ # template: ./templates/uipath-orchestrator.template.yaml
+ # regions:
+ # - us-east-1
+ # parameters:
+ # AvailabilityZones: "$[taskcat_getaz_2]"
+ # UiPathFQDN: testtwo.shivansh.dev #testone.uipathmarketplace.net
+ # VPCCIDR: 10.0.0.0/16
+ # VPCID: <<vpc-id>>
+ # PrivateSubnetIDs: <<subnet-id-1,subnet-id-2,subnet-id-3>>
+ # PublicSubnetIDs: <<subnet-id-1,subnet-id-2,subnet-id-3>>
diff --git a/README.md b/README.md
@@ -0,0 +1,7 @@
+# UIPath Orchestrator on AWS Cloud
+
+For architectural details, step-by-step instructions, and customization options, see the [deployment guide](https://fwd.aws/gnRVW).
+
+To post feedback, submit feature ideas, or report bugs, use the **Issues** section of this GitHub repo. 
+
+To submit code for this Quick Start, see the [AWS Quick Start Contributor's Kit](https://aws-quickstart.github.io/).
diff --git a/UIPath-Orchestrator-arch.png b/UIPath-Orchestrator-arch.png
diff --git a/architecture.png b/architecture.png
diff --git a/docs/deployment_guide/images/architecture_diagram.png b/docs/deployment_guide/images/architecture_diagram.png
diff --git a/docs/deployment_guide/images/aws-quickstart-graphic.png b/docs/deployment_guide/images/aws-quickstart-graphic.png
diff --git a/docs/deployment_guide/images/cfn_outputs.png b/docs/deployment_guide/images/cfn_outputs.png
diff --git a/docs/deployment_guide/images/cfn_outputs2.png b/docs/deployment_guide/images/cfn_outputs2.png
diff --git a/docs/deployment_guide/images/cfnuser.png b/docs/deployment_guide/images/cfnuser.png
diff --git a/docs/deployment_guide/images/create_key_pair.png b/docs/deployment_guide/images/create_key_pair.png
diff --git a/docs/deployment_guide/images/iam_1.png b/docs/deployment_guide/images/iam_1.png
diff --git a/docs/deployment_guide/images/iam_2.png b/docs/deployment_guide/images/iam_2.png
diff --git a/docs/deployment_guide/images/iam_3.png b/docs/deployment_guide/images/iam_3.png
diff --git a/docs/deployment_guide/images/iam_4.png b/docs/deployment_guide/images/iam_4.png
diff --git a/docs/deployment_guide/images/iam_5.png b/docs/deployment_guide/images/iam_5.png
diff --git a/docs/deployment_guide/images/security1.png b/docs/deployment_guide/images/security1.png
diff --git a/docs/deployment_guide/images/test1.png b/docs/deployment_guide/images/test1.png
diff --git a/docs/deployment_guide/images/test2.png b/docs/deployment_guide/images/test2.png
diff --git a/docs/deployment_guide/images/test3.png b/docs/deployment_guide/images/test3.png
diff --git a/docs/deployment_guide/images/test4.png b/docs/deployment_guide/images/test4.png
diff --git a/docs/deployment_guide/partner_editable/_settings.adoc b/docs/deployment_guide/partner_editable/_settings.adoc
@@ -1,15 +1,15 @@
-:partner-solution-project-name: partner-solution-repo-name
-:partner-solution-github-org: aws-quickstart
-:partner-product-name: Full Product Name
-:partner-product-short-name: Product Name
-:partner-company-name: Example Company Name, Ltd.
-:doc-month: January
-:doc-year: 2023
-:partner-contributors: John Smith, {partner-company-name}
+:partner-solution-project-name: cfn-ps-uipath-orchestrator
+:partner-solution-github-org: aws-ia
+:partner-product-name: UiPath Orchestrator
+:partner-product-short-name: UiPath Orchestrator
+:partner-company-name: UiPath
+:doc-month: March
+:doc-year: 2021
+:partner-contributors: Andrei Barbu and Adrian Tudoran, {partner-company-name}
 // :other-contributors: Akua Mansa, Trek10
-:aws-contributors: Janine Singh, AWS IoT Partner team
-:aws-ia-contributors: Toni Jones, AWS Integration & Automation team
-:deployment_time: 15 minutes
+// :aws-contributors: Janine Singh, AWS IoT Partner team
+:aws-ia-contributors: Shivansh Singh and Tony Bulding, AWS Integration & Automation team
+:deployment_time: 25 minutes
 :default_deployment_region: us-east-1
 // :private_repo:
 

diff --git a/docs/deployment_guide/partner_editable/architecture.adoc b/docs/deployment_guide/partner_editable/architecture.adoc
@@ -11,18 +11,23 @@ image::../docs/deployment_guide/images/architecture_diagram.png[Architecture]
 
 As shown in <<architecture1>>, this Partner Solution sets up the following:
 
-* A highly available architecture that spans two Availability Zones.*
-* A virtual private cloud (VPC) configured with public and private subnets, according to AWS
-best practices, to provide you with your own virtual network on AWS.*
+* A highly available architecture that spans two or more Availability Zones.*
+* A virtual private cloud (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 Amazon Elastic Compute Cloud (Amazon EC2) instances in public and private subnets.*
+** A Windows bastion host to control inbound Remote Desktop Protocol (RDP) access to Amazon Elastic Compute Cloud (Amazon EC2) instances in the private subnets.*
+** AWS Storage Gateway providing the file gateway virtual machine image.
+** An Amazon EC2 instance hosting the file gateway.
+** Security groups for fine-grained inbound access to file gateway and bastion host instances.
 * In the private subnets:
-** <item>.
-** <item>.
-// Add bullet points for any additional components that are included in the deployment. Ensure that the additional components are shown in the architecture diagram. End each bullet with a period.
-* <describe any additional components>.
+** An Amazon EC Auto Scaling group with up to 20 UiPath Orchestrator nodes. Nodes are hosted on Amazon EC2 instances running Microsoft Windows Server 2019.
+** A database subnet group for Amazon Relational Database Service (Amazon RDS) DB instances running SQL Server.
+** An Application Load Balancer to balance traffic between UiPath Orchestrator nodes.
+** High-availability add-on for UiPath Orchestrator in a three-node cluster of Amazon EC2 instances with Red Hat Enterprise Linux.
+** Security groups for fine-grained access to UiPath Orchestrator and high-availability add-on instances.
+* AWS Certificate Manager for domain registration with a Secure Sockets Layer certificate.
+* Amazon Route 53 as Domain Name System provider to route traffic to the Application Load Balancer.
+* Amazon CloudWatch for log collection, storage, and analysis, and to enable complete visibility of robots and automation tasks.
+* Amazon S3 bucket for NuGet packages, the automation projects run by UiPath software robots.
+* AWS Identity and Access Management (IAM) role granting access to the S3 bucket to AWS Storage Gateway.
 
 [.small]#* The template that deploys this Partner Solution into an existing VPC skips the components marked by asterisks and prompts you for your existing VPC configuration.#
diff --git a/docs/deployment_guide/partner_editable/deployment_options.adoc b/docs/deployment_guide/partner_editable/deployment_options.adoc
@@ -2,7 +2,7 @@
 
 This Partner Solution provides the following deployment options:
 
-* https://qs_launch_permalink[Deploy {partner-product-short-name} into a new VPC^]. This option builds a new AWS environment that consists 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.
-* https://qs_launch_permalink[Deploy {partner-product-short-name} into an existing VPC^]. This option provisions {partner-product-short-name} in your existing AWS infrastructure.
+* https://fwd.aws/yJgMp[Deploy {partner-product-short-name} into a new VPC^]. This option builds a new AWS environment that consists 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.
+* https://fwd.aws/3rp53[Deploy {partner-product-short-name} into an existing VPC^]. This option provisions {partner-product-short-name} in your existing AWS infrastructure.
 
 This Partner Solution 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.
diff --git a/docs/deployment_guide/partner_editable/licenses.adoc b/docs/deployment_guide/partner_editable/licenses.adoc
@@ -1,3 +1,9 @@
 // Include details about any licenses and how to sign up. Provide links as appropriate.
 
+A license for UiPath is required. To sign up, contact https://www.uipath.com/company/contact-us[UiPath sales]. A free 60-day non-production https://www.uipath.com/developers/studio-download[trial license] is available. 
+
+During deployment, provide your UiPath Orchestrator and UiPath High-Availability add-on license keys on the *Specify stack details* page. Or, manually enter the license keys after the stack is deployed. 
+
+The Partner Solution uses only uses Microsoft Windows images and the Red Hat Enterprise Linux distribution, provided by AWS. An Amazon Machine Image (AMI) subscription is not required.
+
 There is no cost to use this Partner Solution, but you will be billed for any AWS services or resources that this Partner Solution deploys. For more information, refer to the https://fwd.aws/rA69w?[AWS Partner Solution General Information Guide^].
diff --git a/docs/deployment_guide/partner_editable/overview.adoc b/docs/deployment_guide/partner_editable/overview.adoc
@@ -1,7 +1,14 @@
 This guide covers the information you need to deploy the {partner-product-name} Partner Solution in the AWS Cloud.
 
 // Fill in the info in <angle brackets> for use on the landing page only: 
-This Amazon Web Services (AWS) Partner Solution deploys [<product name>](<partner's marketing product page>) in the AWS Cloud so that <purpose>. This solution is for <target users> who want to <do what> so that <why>. For more information, refer to the [<product name> documentation](<URL>).
+This Amazon Web Services (AWS) Partner Solution deploys [<product name>](<partner's marketing product page>) in the AWS Cloud so that you can securely schedule, manage, and control your entire enterprise-wide digital workforce of UiPath software robots. Orchestrator manages the creation, monitoring, and deployment of RPA resources in your environment, acting as an integration point with third-party solutions and applications. For more information, refer to the https://docs.uipath.com/[UiPath Orchestrator documentation^].
+
+UiPath Orchestrator can manage your entire fleet, including the following UiPath Robot types: 
+
+* *Attended* - A robot triggered by user events, operating alongside a human user, and sharing the same workstation. Used with UiPath Orchestrator for centralized process deployment and logging. They can also add data into a queue that is processed by unattended UiPath Robots.
+* *Unattended* - A robot that runs without human supervision in a virtual environment. They run, monitor, schedule, and support work queues remotely.
+* *Development* - An unattended robot used only for development purposes.
+* *Nonproduction* - An unattended robot used only for development and testing purposes.
 
 // Deploying this solution does not guarantee an organization’s compliance with any laws, certifications, policies, or other regulations. [Uncomment this statement only for solutions that relate to compliance. We'll add the corresponding reference part to the landing page and get legal approval before publishing.]
 

diff --git a/docs/deployment_guide/partner_editable/post_deployment.adoc b/docs/deployment_guide/partner_editable/post_deployment.adoc
@@ -1,3 +1,37 @@
 // Include any postdeployment steps here, such as steps necessary to test that the deployment was successful. If there are no postdeployment steps, leave this file empty.
 
 == Postdeployment steps
+
+=== Test the deployment
+// If steps are required to test the deployment, add them here. If not, remove the heading
+[start=1]
+. Verify that UiPath Orchestrator is deployed successfully by navigating to the Application Load Balancer endpoint URL. The *Login* screen shown in <<test1>> will display.
+
+:xrefstyle: short
+[#test1]
+.Test the deployment
+image::../docs/deployment_guide/images/test1.png[test1,width=50%,height=50%]
+
+[start=2]
+. Verify that HAA nodes are deployed successfully. From the bastion host, navigate to any endpoint IP address via https://haa-ip:8443. 
+
+:xrefstyle: short
+[#test2]
+.Logging into High Availability Add-on
+image::../docs/deployment_guide/images/test2.png[test2,width=50%,height=50%]
+
+[start=3]
+. Log in, and verify that all nodes are present on the *Nodes* tab.
+
+:xrefstyle: short
+[#test3]
+.Verifying nodes
+image::../docs/deployment_guide/images/test3.png[test3,width=100%,height=100%]
+
+[start=4]
+. Verify that UiPath Orchestrator can upload to the S3 bucket via the file gateway server. To do this, navigate to the Application Load Balancer endpoint URL and log in. Then, choose *Packages> Upload button > Select a NuGet package* and choose *Upload*.
+
+:xrefstyle: short
+[#test4]
+.Test the deployment
+image::../docs/deployment_guide/images/test4.png[test4,width=100%,height=100%]
diff --git a/docs/deployment_guide/partner_editable/pre_deployment.adoc b/docs/deployment_guide/partner_editable/pre_deployment.adoc
@@ -1,3 +1,16 @@
 //Include any predeployment steps here, such as signing up for a Marketplace AMI or making any changes to a partner account. If there are no predeployment steps, leave this file empty.
 
 == Predeployment steps
+
+===== Key pair 
+Make sure that at least one Amazon EC2 key pair exists in your AWS account in the Region where the Quick Start is deployed. Save the key pair name, as you need it during deployment. To create a key pair, follow the instructions in https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html[Amazon EC2 key pairs and Linux instances^]. For testing or proof-of-concept purposes, we recommend creating a new key pair instead of using one that’s already being used by a production instance.
+
+===== SSL certificate
+This Quick Start requests a certificate from AWS Certificate Manager. It uses DNS certificate validation, using the DNS for the hosted zone that you have set up. If you already have a public certificate that you want to use, you can do so by providing the certificate's Amazon Resource Number (ARN).
+
+===== Valid domain name 
+This Quick Start assumes you have established ownership of the parent domain under which the web application will be served. You should have a hosted zone set up in your AWS account, with the required name server, start of authority, CNAME, and text records. For further details on how to create a public hosted zone, see https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/AboutHZWorkingWith.html[Working with public hosted zones^].
+
+==== Prepare your {partner-company-name} account
+
+This Quick Start uses AWS owned Amazon Machine Images (AMI). However, during the initiation of EC2 virtual machines (VMs), it downloads, installs, and configures UiPath Orchestrator and HAA. Before deployment, purchase UiPath Orchestrator and HAA add-on licenses by https://www.uipath.com/company/contact-us[contacting UiPath directly^].