Skip to content

docs: Improve alicloud privatelink docs #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ciiiii merged 2 commits into from
Jun 16, 2025
Merged

docs: Improve alicloud privatelink docs #132

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a51cc8
Improve docs
ciiiii Jun 16, 2025
43f7cc7
Adjust format
ciiiii Jun 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 34 additions & 9 deletions modules/alicloud/private-link/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
# StreamNative Cloud - Managed AliCloud Private Link

This Terraform module configures your AliCloud network to access private StreamNative BYOC pulsar service.
This Terraform module configures your AliCloud network to access private StreamNative BYOC Pulsar service.

# QuickStart

## Create PrivateLink with default settings
## Pre Requisites

To use this module you must have [Terraform installed](https://learn.hashicorp.com/tutorials/terraform/install-cli) and be familiar with its usage for [AliCloud](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs#authentication). It is recommended to securely store the Terraform configuration you create in source control, as well as use [Terraform's Remote State](https://www.terraform.io/language/state/remote) for storing the `*.tfstate` file.

This module should be applied to the VPC hosting your Pulsar applications. It will create a PrivateLink endpoint and a private DNS zone to provide access to the private Pulsar service in your BYOC AliCloud environments.

## Examples

### Create PrivateLink with default settings

```hcl
provider "alicloud" {
Expand Down Expand Up @@ -32,7 +40,15 @@ module "alicloud_private_link" {
}
```

## Create PrivateLink with customized Security Group
**Parameter Notes**

- `privatelink_service_id`: The ID of the PrivateLink service, it should be obtained from StreamNative Cloud.
- `domain_name`: The domain suffix of the Pulsar endpoint, it should be obtained from StreamNative Cloud.
- `vpc_id`: The ID of the VPC to create the endpoint in, it should be the VPC hosting your Pulsar Applications.
- `endpoint_name`: The name that the VPC endpoint, will be used to identify from other endpoints if you have multiple ones.
- `vswitches`: The list of VSwitches to associate with the endpoint, it should be the VSwitches in the same VPC.

### Create PrivateLink with customized Security Group

```hcl
provider "alicloud" {
Expand Down Expand Up @@ -61,13 +77,22 @@ module "alicloud_private_link" {
}
```

Make sure you have the following inbound rules in your security group:
**Parameter Notes**

- `privatelink_service_id`: The ID of the PrivateLink service, it should be obtained from StreamNative Cloud.
- `domain_name`: The domain suffix of the Pulsar endpoint, it should be obtained from StreamNative Cloud.
- `vpc_id`: The ID of the VPC to create the endpoint in, it should be the VPC hosting your Pulsar Applications.
- `endpoint_name`: The name that the VPC endpoint, will be used to identify from other endpoints if you have multiple ones.
- `vswitches`: The list of VSwitches to associate with the endpoint, it should be the VSwitches in the same VPC.
- `security_group_ids`: The list of existing security group IDs to associate with the endpoint, if this is empty a new security group will be created.

Make sure you have the following inbound rules in your existing security group:

- Allow TCP port 443 from the VPC CIDR
- Allow TCP port 6651 from the VPC CIDR
- Allow TCP port 9093 from the VPC CIDR
- Allow TCP port 5671 from the VPC CIDR
- Allow TCP port 8883 from the VPC CIDR
- Allow TCP port 443 from the VPC CIDR
- Allow TCP port 6651 from the VPC CIDR
- Allow TCP port 9093 from the VPC CIDR
- Allow TCP port 5671 from the VPC CIDR
- Allow TCP port 8883 from the VPC CIDR

## Run terraform

Expand Down
Loading