using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc

Using {prod-cli} to configure the CheCluster Custom Resource during installation

To deploy {prod-short} with a suitable configuration, edit the CheCluster Custom Resource YAML file during the installation of {prod-short}. Otherwise, the {prod-short} deployment uses the default configuration parameterized by the Operator.

Prerequisites

• An active {orch-cli} session with administrative permissions to the {orch-name} cluster. See {orch-cli-link}.

• {prod-cli}. See: installing-the-chectl-management-tool.adoc.

Procedure

• Create a che-operator-cr-patch.yaml YAML file that contains the subset of the CheCluster Custom Resource to configure:

  spec:
    <component>:
        <property_to_configure>: <value>

• Deploy {prod-short} and apply the changes described in che-operator-cr-patch.yaml file:

  $ {prod-cli} server:deploy \
  --che-operator-cr-patch-yaml=che-operator-cr-patch.yaml \
  --platform <chosen_platform>

Verification

1. Verify the value of the configured property:

   $ oc get configmap che -o jsonpath='{.data.<configured_property>}' \
   -n {prod-namespace}

Additional resources

• checluster-custom-resource-fields-reference.adoc.

• advanced-configuration-options-for-the-che-server-component.adoc.