Creating a Connector
A Connector provides a secure connection between a specific remote location and IBM Cloud. Use the Satellite console to create your Connector.
Prerequisites
- To configure Satellite Connectors, you must have Administrator access to the Satellite service in IAM access policies.
- Determine the region where you want to deploy the Connector. For a list of supported regions, see Supported IBM Cloud regions.
Creating a Connector in the console
- From the Satellite console, click Connectors.
- Click Create connector.
- For Name, enter a unique name for your Connector. The default value is
connector
. - For Tags, enter one or more tags that can help you organize resources throughout your account by filtering by tags from your resource list. This field is optional. For more information, see Working with tags.
- For Resource group, assign a resource group to your connector. The default value is
Default
. - For Description, describe what this Connector is used for. This field is optional.
- For the Managed from menu, select the IBM Cloud region that is closest to where your infrastructure resides to ensure low network latency.
- In the Summary panel, review your order details, and then click Create connector.
Prerequisites for creating a Connector
-
Log in to your IBM Cloud account. If you have a federated account, include the
--sso
option, or create an API key to log in.ibmcloud login [--sso]
-
Follow the CLI prompts to select your account.
-
Target your region and resource group.
ibmcloud target -r REGION -g GROUP
Creating a Connector in the CLI
-
Review the command parameters by running the following command.
ibmcloud sat connector create --help
-
Run the following command to create a Connector.
ibmcloud sat connector create --name NAME --region REGION
Example command to create a Connector called
my-connector
inus-south
.ibmcloud sat connector create --name my-connector --region us-south
Example output.
Creating Satellite connector... OK Satellite connector my-connector was successfully created with ID xxxxxxXXXXXXaaaaaaaAAAAA11111
-
Verify your Connector was created by listing the Connectors in your account.
ibmcloud sat connector ls
Example output.
OK ID Name Managed From State xxxxxxXXXXXXaaaaaaaAAAAA11111 my-connector Dallas created
Next steps
After creating a Connector, you must set up an agent to complete your set up.
- Set up a Connector agent. For more information, see Running a Connector agent.
- Run the agent image in Swarm mode for high-availability.
- Follow the end-to-end example to run the agent, configure your endpoints, and add TLS support.