Chapter 1. Add-ons overview

Create a YAML file that is similar to the following KlusterletAddonConfig, with the spec value that represents the add-ons:

apiVersion: agent.open-cluster-management.io/v1
kind: KlusterletAddonConfig
metadata:
  name: <cluster_name>
  namespace: <cluster_name>
spec:
  applicationManager:
    enabled: true
  certPolicyController:
    enabled: true
  iamPolicyController:
    enabled: true
  policyController: 1
    enabled: true
  searchCollector:
    enabled: true

Apply the YAML by running the following command on the hub cluster:

oc apply -f klusterlet-addon-config.yaml

To verify whether the enabled managedClusterAddons are created after the KlusterletAddonConfig is created, run the following command:

oc get managedclusteraddons -n <cluster namespace>

Create a file named addondeploymentconfig.yaml that is based on the following template:

apiVersion: addon.open-cluster-management.io/v1alpha1
kind: AddOnDeploymentConfig
metadata:
  name: config-name 1
  namespace: config-name-space 2
spec:
  nodePlacement:
    nodeSelector: node-selector 3
    tolerations: tolerations 4

A completed AddOnDeployment file might resemble the following example:

apiVersion: addon.open-cluster-management.io/v1alpha1
kind: AddOnDeploymentConfig
metadata:
  name: deploy-config
  namespace: open-cluster-management-hub
spec:
  nodePlacement:
    nodeSelector:
      "node-dedicated": "acm-addon"
    tolerations:
      - effect: NoSchedule
        key: node-dedicated
        value: acm-addon
        operator: Equal

Run the following command to apply the file that you created:

oc apply -f addondeploymentconfig

Use the configuration that you created as the global default configuration for your add-on by running the following command:

oc patch clustermanagementaddons <addon-name> --type='json' -p='[{"op":"add", "path":"/spec/supportedConfigs", "value":[{"group":"addon.open-cluster-management.io","resource":"addondeploymentconfigs", "defaultConfig":{"name":"deploy-config","namespace":"open-cluster-management-hub"}}]}]'

Link the new configuration that you created to your add-on ManagedClusterAddon on a managed cluster.

oc -n <managed-cluster> patch managedclusteraddons <addon-name> --type='json' -p='[{"op":"add", "path":"/spec/configs", "value":[

{"group":"addon.open-cluster-management.io","resource":"addondeploymentconfigs","namespace":"<config-namespace>","name":"<config-name>"}
]}]'

Edit the KlusterletAddonConfig file that is in the namespace of the cluster that needs the proxy. You can use the console to find the resource, or you can edit from the terminal with the following command:

oc -n <my-cluster-name> edit klusterletaddonconfig <my-cluster-name>

Note: If you are working with only one cluster, you do not need <my-cluster-name> at the end of your command. See the following command:

oc -n <my-cluster-name> edit klusterletaddonconfig

Edit the .spec.proxyConfig section of the file so it resembles the following example. The spec.proxyConfig is an optional section:

spec
  proxyConfig:
    httpProxy: "<proxy_not_secure>" 1
    httpsProxy: "<proxy_secure>" 2
    noProxy: "<no_proxy>" 3

If the OpenShift Container Platform cluster is created with cluster wide proxy configured on the hub cluster, the cluster wide proxy configuration values are added to the pods of the klusterlet add-ons as environment variables when the following conditions are met: