Set up Your Environment
This section introduces how to set up a new service account with the minimum permissions to run connectors. To perform the following operations, you need to be the cluster administrator beforehand.
Create a service account for Pulsar users
-
On the left navigation pane of StreamNative Cloud Console, click Service Accounts.
-
Click Create Service Account.
-
Enter a name for the service account, and then click Confirm.
Do NOT check the Super Admin option when creating this service account.
Authorize the service account
To grant the service account permissions on the namespace level, follow these steps:
-
Navigate to the Namespace Dashboard page by switching to the namespace workspace.
-
On the Namespace Dashboard page, click Configuration on the left navigation pane.
-
On the Namespace configuration page, click ADD ROLE, and select the service account that you want to authorize.
-
On the drop-down menu below the service account, select the proper permissions to assign to the service account. There are six permissions in total:
consume: allow the service account to consume messages.produce: allow the service account to publish messages.functions: allow the service account to submit and manage functions.sinks: allow the service account to create and manage sink connectors.sources: allow the service account to create and manage source connectors.packages: allow the service account to upload and manage pulsar packages. If you want to submit a customized function/connector, then you will need to upload the function/connector’s JAR/NAR/Python file first, which requires thepackagespermission.
-
Navigate to the Namespace Dashboard page by switching to the namespace workspace.
-
On the Namespace Dashboard page, click Configuration on the left navigation pane.
-
On the Namespace configuration page, click ADD ROLE, and select the service account that you want to authorize.
-
On the drop-down menu below the service account, select the proper permissions to assign to the service account. There are six permissions in total:
consume: allow the service account to consume messages.produce: allow the service account to publish messages.functions: allow the service account to submit and manage functions.sinks: allow the service account to create and manage sink connectors.sources: allow the service account to create and manage source connectors.packages: allow the service account to upload and manage pulsar packages. If you want to submit a customized function/connector, then you will need to upload the function/connector’s JAR/NAR/Python file first, which requires thepackagespermission.
Grant access to the service account
To grant the underlying infrastructure with access to the newly created service account’s OAuth2 key file, you need to create a service account binding via UI.
Go to the Service Accounts tab and choose the service account you want to use for running the connector. Clicking on the right button and there willbe a Edit service account bindings option.
Click the Edit service account bindings, choose the desired pool member and confirm.
Now your connector is ready to use the service account in StreamNative environments.
Set up client tools
Use snctl to manage Pulsar IO Connectors with Service Account
StreamNative CLI snctl integrates the pulsar admin apis and allows to be used as the pulsar admin CLI to directly access to the StreamNative Cloud cluster. You can use snctl to make the target StreamNative Cloud cluster as the service context, and access to it with selected Service Account.
- use
snctl config set --organization $ORGto your StreamNative Cloud organization. - use
snctl context useto interactivly select your target StreamNative Cloud cluster. - use
snctl pulsar admin --as-service-account $SERVICE_ACCOUNT_NAME ...orsnctl pulsar admin --use-service-account ...to send pulsar admin requests with selected Service Account.
Use pulsarctl or pulsar-admin, Rest Api to manage Pulsar IO Connectors with Service Account
StreamNative Cloud Console provides a step-by-step wizard to walk you through the basic client setup process. You can connect your Pulsar client that uses the previously created service account to interact with your Pulsar cluster.
-
On the left navigation pane of StreamNative Cloud Console, in the Admin section, click Pulsar Clients.
-
Select the CLI Tools tab and follow the wizard to generate the sample code you need for connecting to your Pulsar cluster. The steps may vary depending on the tool you use.
a. Select either
pulsarctlorpulsar-admin,Rest Api.b. Download the selected CLI tool.
c. Select the service account you created.
d. Select OAuth2 as the authentication type and download the key file to your local machine.
e. Set up your CLI tool with that key file, and the steps vary depending on the CLI tool you use.
f. Copy the command for setting client configurations to your terminal, update the path of the OAuth2 key file, and run it.
g. Select the target tenant, namespace and topic, and copy the sample command to run.
f. Copy the command for setting client configurations to your terminal, update the path of the OAuth2 key file, and run it.
g. Select the target tenant, namespace and topic, and copy the sample command to run.
f. Select the target tenant, namespace and topic, and copy the sample command to your terminal and update the path of the OAuth2 key file before running.
f. Select the target tenant, namespace and topic, and copy the sample curl command to your terminal and update the path of the OAuth2 key file before running.