Automatically propagate Salesforce configuration to all clusters

Available since 2.17.0

You can enable automatic propagation of the Salesforce configuration of your management cluster to the related regional and managed clusters using the autoSyncSalesForceConfig=true flag added to the Cluster object of the management cluster. This option allows for automatic update and sync of the Salesforce settings on all your clusters after you update your management cluster configuration.

You can also set custom settings for regional and managed clusters that always override automatically propagated Salesforce values.

Enable propagation of Salesforce configuration using web UI

Available since 2.18.0

  1. Log in to the Container Cloud web UI as m:kaas@global-admin or m:kaas@writer.

  2. In the Clusters tab, click the More action icon in the last column of the required management cluster and select Configure.

  3. In the Configure cluster window, navigate to Stacklight > Sales Force and select Sales Force Configuration Propagation To Regional And Child Clusters.

  4. Click Update.

    Once the automatic propagation applies, the Events section of the corresponding managed cluster displays the following message: Propagated Cluster Salesforce Config From Management <clusterName> Cluster uses SalesForce configuration from management cluster.

Note

To set custom Salesforce settings for your regional and managed clusters that will override the related management cluster settings, refer to the optional step in Enable propagation of Salesforce configuration using CLI.

Enable propagation of Salesforce configuration using CLI

Available since 2.17.0

  1. Download your management cluster kubeconfig:

    1. Log in to the Container Cloud web UI with the m:kaas:namespace@operator or m:kaas:namespace@writer permissions.

    2. Switch to the required project using the Switch Project action icon located on top of the main left-side navigation panel.

    3. Expand the menu of the tab with your user name.

    4. Click Download kubeconfig to download kubeconfig of your management cluster.

    5. Log in to any local machine with kubectl installed.

    6. Copy the downloaded kubeconfig to this machine.

  2. In the Cluster objects of the required regional and managed clusters, remove all Salesforce settings that you want to automatically sync with the same settings of the management cluster:

    kubectl --kubeconfig <mgmtClusterKubeconfigPath> edit -n <managedOrRegionalClusterProjectName> cluster <managedOrRegionalClusterName>
    

    From the StackLight values section, remove the following Salesforce parameters:

    spec:
      ...
      providerSpec:
        value:
          helmReleases:
          - name: stacklight
            values:
              ...
    
    alertmanagerSimpleConfig.salesForce.enabled
    alertmanagerSimpleConfig.salesForce.auth
    sfReporter.salesForceAuth
    sfReporter.enabled
    sfReporter.cronjob
    

    For details about these parameters, refer to StackLight configuration parameters for Salesforce.

  3. In the management section of the management cluster Cluster object, add the autoSyncSalesForceConfig: true flag:

    kubectl --kubeconfig <kubeconfigPath> edit -n <projectName> cluster <managementClusterName>
    
    spec:
      ...
      providerSpec:
        value:
          kaas:
          ...
            management:
              ...
              autoSyncSalesForceConfig: true
    

    Note

    If the autoSyncSalesForceConfig is not set to any value, automatic propagation is disabled.

    Once enabled, the following Salesforce parameters are copied to all regional and managed clusters where these settings were not configured yet:

    alertmanagerSimpleConfig.salesForce.enabled
    alertmanagerSimpleConfig.salesForce.auth
    sfReporter.salesForceAuth
    sfReporter.enabled
    sfReporter.cronjob
    

    The existing Salesforce settings of regional and managed clusters will not be overridden after you enable automatic propagation.

    To verify the automatic propagation status:

    kubectl edit helmbundles <managedClusterName> -n <managedClusterProjectName>
    
  4. Optional. Set custom Salesforce settings for your regional and managed clusters to override the related management cluster settings. Add the required custom settings to the StackLight values section of the corresponding Cluster object of your regional and managed clusters:

    spec:
      ...
      providerSpec:
        value:
          helmReleases:
          - name: stacklight
            values:
              ...
    

    For details, refer to StackLight configuration procedure and StackLight configuration parameters for Salesforce.

    Note

    Custom settings are not overridden if you update the management cluster settings for Salesforce.