Skip to content
This repository has been archived by the owner on Oct 4, 2024. It is now read-only.

Commit

Permalink
Merge pull request #34 from aws-quickstart/doc-edits
Browse files Browse the repository at this point in the history
Submodule Updates and rebranding
  • Loading branch information
vsnyc authored Aug 8, 2023
2 parents d06d2d8 + e388844 commit 4dcead0
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 13 deletions.
10 changes: 5 additions & 5 deletions docs/deployment_guide/partner_editable/architecture.adoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
:xrefstyle: short

Deploying this Quick Start with default parameters builds the following {partner-product-short-name} environment in the
Deploying this Partner Solution 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 its repository.

[#architecture1]
.Quick Start architecture for {partner-product-short-name} on AWS
.Partner Solution architecture for {partner-product-short-name} on AWS
image::../docs/deployment_guide/images/solace-pubsub-architecture-diagram.png[Architecture]

As shown in <<architecture1>>, this Quick Start sets up the following:
As shown in <<architecture1>>, this Partner Solution sets up the following:

* A highly available architecture that spans three Availability Zones. If you deploy the Quick Start in an AWS Region that has only two Availability Zones or you choose to use only two Availability Zones, the backup and monitoring instances of the message broker will be placed in the same Availability Zone.*
* A highly available architecture that spans three Availability Zones. If you deploy the Partner Solution in an AWS Region that has only two Availability Zones or you choose to use only two Availability Zones, the backup and monitoring instances of the message broker will be placed in the same Availability Zone.*
+
NOTE: We recommend using three Availability Zones, where available, for production systems.
* A virtual private cloud (VPC) configured with public and private subnets, according to AWS
Expand All @@ -26,7 +26,7 @@ Shell (SSH) access to Amazon Elastic Compute Cloud (Amazon EC2) instances in pub
* Elastic Load Balancing (ELB) load balancer support with health checks (using Network Load Balancer).
* CloudWatch logging support, including the log file /tmp/install-solace.log, which logs the events during installation.
[.small]#* The template that deploys this Quick Start into an existing VPC skips the components marked by asterisks and prompts you for your existing VPC configuration.#
[.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.#

NOTE: For non-production test or proof-of-concept (PoC) environments, you can choose to omit the private subnets. In that case all components in the private subnets will be deployed in the public subnets and no Linux bastion host will be required. There will be also no Load balancer deployed, all PubSub+ event brokers will have public access.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
This Quick Start provides the following deployment options:
This Partner Solution provides the following deployment options:

* https://fwd.aws/QPexg[Deploy {partner-product-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/9rpbM[Deploy {partner-product-name} into an existing VPC^]. This option provisions {partner-product-short-name} in your existing AWS infrastructure.
This 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.
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.

2 changes: 1 addition & 1 deletion docs/deployment_guide/partner_editable/licenses.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
// Include details about any licenses and how to sign up. Provide links as appropriate.

There is no cost to use this Quick Start, but you will be billed for any AWS services or resources that this Quick Start deploys. For more information, refer to the https://fwd.aws/rA69w?[AWS Quick Start General Information Guide^].
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^].
4 changes: 2 additions & 2 deletions docs/deployment_guide/partner_editable/overview.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
This Quick Start deploys https://solace.com/products/event-broker/[{partner-product-name}^] on the AWS Cloud. If you are unfamiliar with AWS Quick Starts, refer to the https://fwd.aws/rA69w?[AWS Quick Start General Information Guide^].
This Partner Solution deploys https://solace.com/products/event-broker/[{partner-product-name}^] on the AWS Cloud. If you are unfamiliar with AWS Partner Solutions, refer to the https://fwd.aws/rA69w?[AWS Partner Solution General Information Guide^].

For advanced information about the product that this Quick Start deploys, refer to the https://{quickstart-github-org}.github.io/{quickstart-project-name}/operational/index.html[Solace PubSub+ Technical Documentation^].
For advanced information about the product that this Partner Solution deploys, refer to the https://{quickstart-github-org}.github.io/{quickstart-project-name}/operational/index.html[Solace PubSub+ Technical Documentation^].
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

=== Checking the Deployment Stack

The Quick Start will create the nested VPC, bastion host, and Solace stacks by using the respective templates. The Solace stack creates additional sub-stacks for the deployment of the primary, backup, and monitor PubSub+ event broker nodes. You’ll see all these listed in the AWS CloudFormation console, as illustrated in <<created-stacks-after-deployment>>.
The Partner Solution will create the nested VPC, bastion host, and Solace stacks by using the respective templates. The Solace stack creates additional sub-stacks for the deployment of the primary, backup, and monitor PubSub+ event broker nodes. You’ll see all these listed in the AWS CloudFormation console, as illustrated in <<created-stacks-after-deployment>>.

[#created-stacks-after-deployment]
.Created stacks after deployment
Expand Down
4 changes: 2 additions & 2 deletions docs/deployment_guide/partner_editable/troubleshooting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Both PubSub+ host and container logs get logged to Amazon CloudWatch on the regi
.Event Broker logs in CloudWatch
image::../docs/deployment_guide/images/logs-in-cloudwatch.png[Event Broker logs in CloudWatch]

=== Common Quick Start issues
=== Common Partner Solution issues

For troubleshooting common Quick Start issues, refer to the https://fwd.aws/rA69w?[AWS Quick Start General Information Guide^] and https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html[Troubleshooting CloudFormation^].
For troubleshooting common Partner Solution issues, refer to the https://fwd.aws/rA69w?[AWS Partner Solution General Information Guide^] and https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html[Troubleshooting CloudFormation^].


0 comments on commit 4dcead0

Please sign in to comment.