General parameters

Use the general parameters such as license, secret, service account, to create SIPEnvironment.

The following YAML snippet is a sample schema of the general parameters of SIPEnvironment:

kind: SIPEnvironment
metadata:
  name: ""
  annotations:
  # Use the following annotation to skip the check for ibm-entitlement-key secret. 
    apps.sip.ibm.com/skip-ibm-entitlement-key-check: 'yes'
spec:
  license
    accept: true
  secret: ""
  # sipVersion: 10.0.2604.0
  # serviceAccount: default
  # upgradeStrategy: RollingUpdate
  # tenantId: default
  # UsePublicImageRegistry: true
  # environment: qa
  # multiDCEnabled: false

The following table explains the general parameters of SIPEnvironment:

Property	Default value	Value type	Required	Description
`licence.accept`		boolean	Yes	Accept IBM® Sterling Intelligent Promising license.
`sipVersion`		string	No	Specify the required version of the IBM Sterling Intelligent Promising to be upgraded. For more information, see Version validation process.
`secret`		string	Yes	Provide the name of the secret containing sensitive properties for deployment as explained in Creating a secret page.
`environment`		string	No	Provide the name of the environment that you want to set for the Kafka topics as a prefix. For more information about Kafka topics, see Kafka topic list for the services.
`multiDCEnabled`	false	boolean	No	Specify this property to enable or disable multidatacenter support.
`serviceAccount`	`default`	string	No	Specify the name of the service account that is used for deployment.
`tenantid`	`default`	string	No	The default value for tenant ID is `default`. Do not change the default value.
`upgradeStrategy`	`RollingUpdate`	string	No	Specify the deployment strategy to be used for upgrading the `SIPEnvironment` deployments. Available options are `RollingUpdate and Recreate`.
`datacenter`	`local`	string	No	Specify the datacenter name of the compute cluster where you host and manage Sterling Intelligent Promising deployment. It is recommended to provide a valid datacenter name based on your business requirements.
`UsePublicImageRegistry`	true	boolean	No	Specify whether to use a public image registry for downloading images. Set it to `true` if you want to download images from a public registry such as Docker Hub, Red Hat®. Set it to `false` if you want to use a private repository that is defined in the `image` section. For more information, see Pulling images from private repositories.

Version validation process

When the sipVersion property is configured in the SIPEnvironment custom resource, the Operator performs a validation to determine whether the system can safely transition to the specified version. Service updates proceed only after this validation is successful, ensuring that upgrades occur in a controlled and compatible manner. If the validation fails, the upgrade process is halted to prevent inconsistent states.

In order to facilitate this validation process, you must create a new keyspace <cassandra.lifecycle_manager_keyspace> for version validation in your Cassandra database before starting the deployment or upgrade.

After the deployment is complete, you must proceed with the post-upgrade steps if there are any. Once the post-upgrade is complete, set the following annotation to true, after which the system assume the process is complete.

apps.sip.ibm.com/post-upgrade-manual-step-completed: true