Oracle Cloud Infrastructure Documentation

Installing Cluster Add-ons

Install add-ons to your managed Kafka clusters to extend support for specific networking, security, or operational needs.

For information about the add-ons you can install, see Using Add-ons with Kafka Clusters. Currently, there is only one add-on available for installation: the Public connectivity add-on.

Note

Before installing the Public connectivity add-on, secure your Kafka cluster by first creating an Apache Kafka access control list and then updating the cluster's configuration to change the allow.everyone.if.no.acl.found property to false.
    1. On the Kafka clusters list page, find the cluster that you want to work with. If you need help finding the list page or the cluster, see Listing Clusters.
    2. Select Add-ons.
    3. Select Install add-on.
    4. On the Install add-on panel, in Add-on type, select Public connectivity.
    5. Enter a name and description for the add-on.
      The name must be unique across all installed add-ons.
    6. In the Public connectivity configuration section, select the authentication type:
      • SASL
      • mTLS
    7. In Network CIDR, enter the CIDR range that can access this Kafka cluster over the public internet.
      Note

      Enter public ranges only.
    8. Select Add Network CIDR to enter additional CIDR ranges, as needed.
    9. Select Install.
      Tip

      If the add-on can't be installed, a warning will display at the top of the Add-ons tab with a link to the Work requests page where you can view the installation errors. Review the reasons why the add-on couldn't be installed, then uninstall the add-on and try again.
    10. After installing an add-on, you can later change the add-on's name and included CIDR ranges, if needed:
      1. On the Add-ons tab, from the Actions menu (three dots) for the add-on, select Edit.
      2. Change the description and CIDR ranges, as needed.
      3. Select Update.
    11. To change an existing add-on's authentication type, you must uninstall the add-on and then re-create it. To uninstall an add-on:
      1. On the Add-ons tab, from the Actions menu (three dots) for the add-on, select Uninstall.

  • Use these CLI commands and required parameters to work with add-ons, in general:

    • To list add-ons:
      oci kafka cluster list-addons --kafka-cluster-id "<kafka-cluster-ocid>" [OPTIONS]
    • To get details about an add-on:
      oci kafka cluster get-addon --addon-name "<addon-name>" --kafka-cluster-id "<kafka-cluster-ocid>"
    • To uninstall an add-on:
      oci kafka cluster uninstall-addon --addon-name "<addon-name>" --kafka-cluster-id "<kafka-cluster-ocid>" [OPTIONS]

    Use these CLI commands and required parameters to work with the Public connectivity add-on:

    • To install the Public connectivity add-on:
      oci kafka cluster install-public-connectivity-addon [OPTIONS]
    • To update a Public connectivity add-on:
      oci kafka cluster update-public-connectivity-addon [OPTIONS]

    For a complete list of flags and variable options for CLI commands, see the CLI Command Reference.

  • Run these operations to work with add-ons:

    • InstallKafkaClusterAddon
    • ListKafkaClusterAddons
    • GetKafkaClusterAddon
    • UpdateKafkaClusterAddon
    • UninstallKafkaClusterAddon
    • ListAddonOptions

    For more information, see Oracle Streaming with Apache Kafka (OSAK) API.