> ## Documentation Index
> Fetch the complete documentation index at: https://docs.streamnative.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Manage Connectors

StreamNative Cloud enables you to manage Pulsar IO Connectors by using a variety of tools, including `snctl`, `pulsarctl`, `pulsar-admin`, and `Terraform`.

<Note title="Note">
  If you want to update or delete connectors using `snctl`, `pulsarctl` or `pulsar-admin`, make sure you have set up your client tool. For more information, see [set up client tools](/cloud/connect/pulsar-io/deploy-connectors/connector-setup#set-up-client-tools).
</Note>

## Update a connector

When you want to modify configurations or update resources for connectors, you can update connectors using multiple tools.

The following example shows how to update the parallelism of the data generator source connector `test` to `2` using different tools.

<Tabs>
  <Tab title="snctl">
    ```bash theme={null}
    snctl pulsar admin sources update \
    --name test \
    --parallelism 2
    ```

    You should see the following output:

    ```bash theme={null}
    Updated successfully
    ```

    And you can further check the status:

    ```bash theme={null}
    snctl pulsar admin sources status --name test

    {
      "numInstances": 2,
      "numRunning": 2,
      "instances": [
        {
          "instanceId": 0,
          "status": {
            "running": true,
            "error": "",
            "numRestarts": 0,
            "numReceivedFromSource": 1799,
            "numSystemExceptions": 0,
            "latestSystemExceptions": [],
            "numSourceExceptions": 0,
            "latestSourceExceptions": [],
            "numWritten": 1799,
            "lastReceivedTime": 1693946327331,
            "workerId": "test"
          }
        },
        {
          "instanceId": 1,
          "status": {
            "running": true,
            "error": "",
            "numRestarts": 0,
            "numReceivedFromSource": 689,
            "numSystemExceptions": 0,
            "latestSystemExceptions": [],
            "numSourceExceptions": 0,
            "latestSourceExceptions": [],
            "numWritten": 689,
            "lastReceivedTime": 1693946327129,
            "workerId": "test"
          }
        }
      ]
    }

    ```
  </Tab>

  <Tab title="pulsarctl">
    ```bash theme={null}
    pulsarctl sources update \
    --name test \
    --parallelism 2
    ```

    You should see the following output:

    ```bash theme={null}
    Updated successfully
    ```

    And you can further check the status:

    ```bash theme={null}
    pulsarctl sources status --name test

    {
      "numInstances": 2,
      "numRunning": 2,
      "instances": [
        {
          "instanceId": 0,
          "status": {
            "running": true,
            "error": "",
            "numRestarts": 0,
            "numReceivedFromSource": 1799,
            "numSystemExceptions": 0,
            "latestSystemExceptions": [],
            "numSourceExceptions": 0,
            "latestSourceExceptions": [],
            "numWritten": 1799,
            "lastReceivedTime": 1693946327331,
            "workerId": "test"
          }
        },
        {
          "instanceId": 1,
          "status": {
            "running": true,
            "error": "",
            "numRestarts": 0,
            "numReceivedFromSource": 689,
            "numSystemExceptions": 0,
            "latestSystemExceptions": [],
            "numSourceExceptions": 0,
            "latestSourceExceptions": [],
            "numWritten": 689,
            "lastReceivedTime": 1693946327129,
            "workerId": "test"
          }
        }
      ]
    }

    ```
  </Tab>

  <Tab title="pulsar-admin">
    ```bash theme={null}
    pulsar-admin \
        --admin-url "${WEB_SERVICE_URL}" \
        --auth-plugin org.apache.pulsar.client.impl.auth.oauth2.AuthenticationOAuth2 \
        --auth-params '{"privateKey":"file:///YOUR-KEY-FILE-PATH",
            "issuerUrl":"https://auth.streamnative.cloud/",
            "audience":"urn:sn:pulsar:${orgName}:${instanceName}}'
    sources update \
    --name test \
    --parallelism 2
    ```

    Replace the placeholder variables with the actual values, which you can get when you set up client tools.

    * `admin-url`: the HTTP service URL of your Pulsar cluster.
    * `private_key`: the path to the downloaded OAuth2 key file.
    * `audience`: the [Uniform Resource Name (URN)](/cloud/references/glossary#uniform-resource-name-urn), which is a combination of the `urn:sn:pulsar`, your organization name, and your Pulsar instance name.
      * `${orgName}`: the name of your [organization](/cloud/references/glossary#organization).
      * `${instanceName}`: the name of your [instance](/cloud/references/glossary#instance).

    You should see the following output:

    ```bash theme={null}
    Updated successfully
    ```

    And you can further check the status:

    ```bash theme={null}
    pulsar-admin sources status --name test
    {
      "numInstances" : 2,
      "numRunning" : 2,
      "instances" : [ {
        "instanceId" : 0,
        "status" : {
          "running" : true,
          "error" : "",
          "numRestarts" : 0,
          "numReceivedFromSource" : 1287,
          "numSystemExceptions" : 0,
          "latestSystemExceptions" : [ ],
          "numSourceExceptions" : 0,
          "latestSourceExceptions" : [ ],
          "numWritten" : 1287,
          "lastReceivedTime" : 1693946605095,
          "workerId" : "test"
        }
      }, {
        "instanceId" : 1,
        "status" : {
          "running" : true,
          "error" : "",
          "numRestarts" : 0,
          "numReceivedFromSource" : 909,
          "numSystemExceptions" : 0,
          "latestSystemExceptions" : [ ],
          "numSourceExceptions" : 0,
          "latestSourceExceptions" : [ ],
          "numWritten" : 909,
          "lastReceivedTime" : 1693946605023,
          "workerId" : "test"
        }
      } ]
    }
    ```
  </Tab>

  <Tab title="Terraform">
    To update the submitted connector, you only need to update the Terraform file and then call the following command.

    ```bash theme={null}
    # update the main.tf file
    terraform apply

    # output
    pulsar_source.test: Refreshing state... [id=public/default/dg-test-tf]

    Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
      ~ update in-place

    Terraform will perform the following actions:

      # pulsar_source.test will be updated in-place
      ~ resource "pulsar_source" "test" {
          ~ archive                    = "connectors/pulsar-io-data-generator-2.9.2.17.nar" -> "builtin://data-generator"
          - custom_runtime_options     = jsonencode(
                {
                  - clusterName         = "test"
                  - managed             = true
                  - maxReplicas         = 0
                  - outputTypeClassName = "org.apache.pulsar.io.datagenerator.Person"
                  - serviceAccountName  = "test-function-pulsarcluster"
                }
            ) -> null
            id                         = "public/default/dg-test-tf"
            name                       = "dg-test-tf"
          ~ parallelism                = 1 -> 2
            # (10 unchanged attributes hidden)
        }

    Plan: 0 to add, 1 to change, 0 to destroy.

    Do you want to perform these actions?
      Terraform will perform the actions described above.
      Only 'yes' will be accepted to approve.

      Enter a value: yes

    pulsar_source.test: Modifying... [id=public/default/dg-test-tf]
    pulsar_source.test: Modifications complete after 1s [id=public/default/dg-test-tf]

    Apply complete! Resources: 0 added, 1 changed, 0 destroyed.
    ```
  </Tab>

  <Tab title="Console">
    1. On the left navigation pane of StreamNative Console, under **Resources**, click **Connectors**.

    2. On the Connectors page, select the **Created Sources** tab.

    3. Click the ellipsis at the end of the row of the connector, and then click **Edit**.

    4. Edit the configuration that you want to change, and click **SUBMIT**.
  </Tab>

  <Tab title="Rest API">
    ```bash theme={null}
    curl -X PUT https://${WEB_SERVICE_URL}/admin/v3/sources/{tenant}/{namespace}/test \
      -H 'Authorization: Bearer <API Key>' \
      -H "Content-Type: multipart/form-data" \
      -F 'sourceConfig={"name": "test", "tenant": "public", "namespace": "default", "parallelism": 2};type=application/json'
    ```

    If no error is response, the update is successful.

    And you can further check the status:

    ```bash theme={null}
    curl -X GET https://${WEB_SERVICE_URL}/admin/v3/sources/public/default/test/status \
      --header 'Authorization: Bearer <API Key>' | jq '.'
    {
      "numInstances": 2,
      "numRunning": 2,
      "instances": [
        {
          "instanceId": 0,
          "status": {
            "running": true,
            "error": "",
            "numRestarts": 0,
            "numReceivedFromSource": 1799,
            "numSystemExceptions": 0,
            "latestSystemExceptions": [],
            "numSourceExceptions": 0,
            "latestSourceExceptions": [],
            "numWritten": 1799,
            "lastReceivedTime": 1693946327331,
            "workerId": "test"
          }
        },
        {
          "instanceId": 1,
          "status": {
            "running": true,
            "error": "",
            "numRestarts": 0,
            "numReceivedFromSource": 689,
            "numSystemExceptions": 0,
            "latestSystemExceptions": [],
            "numSourceExceptions": 0,
            "latestSourceExceptions": [],
            "numWritten": 689,
            "lastReceivedTime": 1693946327129,
            "workerId": "test"
          }
        }
      ]
    }
    ```
  </Tab>
</Tabs>

## Delete a connector

The following example shows how to delete the data generator source connector `test` using different tools.

<Tabs>
  <Tab title="snctl">
    To delete the source connector `test`, use the following command.

    ```bash theme={null}
    snctl pulsar admin sources delete --tenant public --namespace default --name test
    ```

    You should see the following output:

    ```bash theme={null}
    Deleted test successfully
    ```

    If you want to verify whether the source connector has been deleted successfully, run the following command.

    ```bash theme={null}
    snctl pulsar admin sources get --tenant public --namespace default --name test
    ```

    You should see the following output:

    ```bash theme={null}
    [✖]  code: 500 reason: failed to perform the request: responseCode: 404, responseMessage: sources.compute.functionmesh.io "test-XXXXX" not found
    ```
  </Tab>

  <Tab title="pulsarctl">
    To delete the source connector `test`, use the following command.

    ```bash theme={null}
    pulsarctl sources delete --tenant public --namespace default --name test
    ```

    You should see the following output:

    ```bash theme={null}
    Deleted test successfully
    ```

    If you want to verify whether the source connector has been deleted successfully, run the following command.

    ```bash theme={null}
    pulsarctl sources get --tenant public --namespace default --name test
    ```

    You should see the following output:

    ```bash theme={null}
    [✖]  code: 500 reason: failed to perform the request: responseCode: 404, responseMessage: sources.compute.functionmesh.io "test-XXXXX" not found
    ```
  </Tab>

  <Tab title="pulsar-admin">
    To delete the source connector `test`, run the following command.

    ```bash theme={null}
    ./bin/pulsar-admin sources delete  --tenant public --namespace default --name test
    ```

    You should see the following output:

    ```bash theme={null}
    Delete source successfully
    ```

    To verify the source connector has been deleted, run the following command.

    ```bash theme={null}
    ./bin/pulsar-admin sources get --tenant public --namespace default --name test
    ```

    You should see the following output:

    ```bash theme={null}
    failed to perform the request: responseCode: 404, responseMessage: sources.compute.functionmesh.io "test-e9ef0ca6" not found
    ```
  </Tab>

  <Tab title="Terraform">
    To delete the source connector `test` with terraform, run the following command and type `yes` on the prompt.

    ```bash theme={null}
    terraform destroy

    # output
    pulsar_source.test: Refreshing state... [id=public/default/dg-test-tf]

    Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
      - destroy

    Terraform will perform the following actions:

      # pulsar_source.test will be destroyed
      - resource "pulsar_source" "test" {
          - archive                    = "connectors/pulsar-io-data-generator-2.9.2.17.nar" -> null
          - classname                  = "org.apache.pulsar.io.datagenerator.DataGeneratorSource" -> null
          - configs                    = jsonencode(
                {
                  - sleepBetweenMessages = "60"
                }
            ) -> null
          - cpu                        = 1 -> null
          - custom_runtime_options     = jsonencode(
                {
                  - clusterName         = "test"
                  - managed             = true
                  - maxReplicas         = 0
                  - outputTypeClassName = "org.apache.pulsar.io.datagenerator.Person"
                  - serviceAccountName  = "test-function-pulsarcluster"
                }
            ) -> null
          - destination_topic_name     = "public/default/dg-test" -> null
          - disk_mb                    = 10240 -> null
          - id                         = "public/default/dg-test-tf" -> null
          - name                       = "dg-test-tf" -> null
          - namespace                  = "default" -> null
          - parallelism                = 2 -> null
          - processing_guarantees      = "ATMOST_ONCE" -> null
          - ram_mb                     = 1024 -> null
          - tenant                     = "public" -> null
          - use_thread_local_producers = false -> null
        }

    Plan: 0 to add, 0 to change, 1 to destroy.

    Do you really want to destroy all resources?
      Terraform will destroy all your managed infrastructure, as shown above.
      There is no undo. Only 'yes' will be accepted to confirm.

      Enter a value: yes

    pulsar_source.test: Destroying... [id=public/default/dg-test-tf]
    pulsar_source.test: Destruction complete after 1s

    Destroy complete! Resources: 1 destroyed.
    ```
  </Tab>

  <Tab title="Console">
    1. On the left navigation pane of StreamNative Console, under **Resources**, click **Connectors**.

    2. On the Connectors page, select the **Created Sources** tab.

    3. Click the ellipsis at the end of the row of the connector, and then click **Delete**.

    4. Enter the connector name and then click **Confirm**.
  </Tab>

  <Tab title="Rest API">
    To delete the source connector `test`, use the following command.

    ```bash theme={null}
    curl -X DELETE https://${WEB_SERVICE_URL}/admin/v3/sources/public/default/test \
      --header 'Authorization: Bearer <API Key>'
    ```

    If no error is response, the delete is successful.

    If you want to verify whether the source connector has been deleted successfully, run the following command.

    ```bash theme={null}
    curl -X GET https://${WEB_SERVICE_URL}/admin/v3/sources/public/default/test/status \
      --header 'Authorization: Bearer <API Key>' | jq '.'
    ```

    You should see the following output:

    ```bash theme={null}
    {"reason":"failed to perform the request: responseCode: 404, responseMessage: sources.compute.functionmesh.io \"test-6b51d8ef\" not found"}%
    ```
  </Tab>
</Tabs>