(Optional) Creating your custom resource from the CR template

The preferred method for obtaining a simple custom resource YAML file (CR) is to use the prerequisites script. However, all Kubernetes descriptors that are necessary to install manually can be found in the container-samples repository. You can install components by creating a custom resource by hand and then running commands on the platform.

About this task

If you are using the simplified CR template, you can install Content Platform Engine, IBM Content Navigator, and GraphQL API, with default settings, with no customization. If you want to install additional components, set those values as true in the content_optional_components parameter. For example:

content_optional_components:
  cpe: true
  graphql: true
  cmis: true
  css: true
  es: true
  tm: true
  ban: true

For a more customized deployment, you can start with the simplified CR template or fully customizable CR template, and copy component sections into the template to provide custom settings. For more information, see Custom resource pattern structure.

Procedure

  1. Make a copy of the custom resource YAML file from the container-samples repository and name the file for your deployment.
    You can make a copy of either the simplified or fully customizable CR YAML file, whichever reflects what you intend to deploy and name the file as (ibm_fncm_my_cr_final.yaml). You can access the files from the container-samples repository:
    • For simplified CR: descriptors/ ibm_fncm_cr_production.yaml.
    • For fully customizable CR:descriptors/ ibm_fncm_cr_production_FC_content.yaml

      For information on downloading the container-samples repository, see Preparing a client to connect to the cluster.

  2. Copy and paste component sections into the YAML as needed, so that your YAML reflects all of the components that you want to deploy.
    Note: The metadata.name setting is used as a prefix for multiple objects. You need to specify a short CR name as the maximum length of labels in Kubernetes is 63 characters,. The total length of the CR name and an instance name must not exceed 24 characters, otherwise some component deployments fail. For example,
    metadata:
      name: fncmdeploy

What to do next

If you want to further customize and configure the custom resource, see Configuring an advanced custom resource.