Downloading and Installing Siebel Cloud Manager
Use this task to create and deploy the SCM stack (that is, to install the SCM instance in a virtual machine instance on OCI).
Before you perform this task, if you want SCM to create the Git repository, install GitLab Enterprise Edition (if it isn't already installed) into the same compartment where you install SCM. For more information, see Installing GitLab.
During stack creation, review all default values displayed. Confirm each value or enter a new value as appropriate for your task. Steps for verifying SCM are also included.
To download and install SCM
-
Start the OCI console and log in.
-
Navigate to Marketplace, All applications.
-
Search for Siebel Cloud Manager.
-
Drill down on the Siebel Cloud Manager link.
-
Select the version and compartment (which you created in Creating a Compartment), check review terms and conditions, and then Launch Stack.
-
Navigate to the Stack Variables page.
- Under General, provide the following details:
- The OCID of the root compartment for your SCM instance (the compartment you created in Step 5)
- The SSH public key for accessing the SCM instance.
- The resource prefix (all the resources created through this stack have this prefix added).
- Specify whether you want to use existing resources (such as Compartment,
VCN, mount target, database, and OKE) for the SCM instance.
Selecting the "Use Existing Resources" option allows you to choose your existing resources (such as Compartment, VCN, mount target, database and OKE) for SCM configuration and Siebel environment provisioning. If you don't select this option, SCM creates all the above mentioned resources.
- Under Permissions, specify one of the following
permission type for the SCM instance:
- Instance Principal: When you use Instance Principal, specify whether you
want to use any existing dynamic group and policy. By default, the "Use
Existing Dynamic Group and Policy" checkbox is not selected, so a
dynamic group is created and an OCI CLI policy is created and assigned
to the SCM instance. If you select the "Use Existing Dynamic Group and
Policy" checkbox then, after the Apply stack job is completed, you need
to manually add a new matching rule
"instance.id=<cm_instance_id>"
in an existing dynamic group -<dynamic_group_name>
and you also need to add a new policy statement"Allow dynamic-group <dynamic_group_name>
tomanage all-resources in compartment id <cm_compartment_ocid>"
in an existing policy. This policy allows you to access and perform various CRUD operations in SCM compartment from SCM instance. - User Principal: When you use User Principal, no dynamic group and policy are attached to the SCM instance, and the OCI configuration is done manually. The necessary details, such as the user's private key, OCI fingerprint, and OCI passphrase are received and a configuration is set up. The private key and fingerprint are generated from the user's OCI Console, under Users > Resources > API Keys. All the permissions that apply for this user are available to the SCM instance.
- Instance Principal: When you use Instance Principal, specify whether you
want to use any existing dynamic group and policy. By default, the "Use
Existing Dynamic Group and Policy" checkbox is not selected, so a
dynamic group is created and an OCI CLI policy is created and assigned
to the SCM instance. If you select the "Use Existing Dynamic Group and
Policy" checkbox then, after the Apply stack job is completed, you need
to manually add a new matching rule
- Under VCN, specify whether you want to use existing VCN
resource. This option allows using your existing network component resources and
lets SCM to create and manage other resources such as mount target, file system,
database and OKE.
- Network component for SCM Instance: Locate the compartment where the
desired VCN is present for creating the SCM instance and in the
following drop-down field select an existing VCN and a subnet. Note:
- Allow TCP port 22 from your client network to establish SSH connection to the SCM instance.
- Allow TCP port 16690 from your client network to access the SCM application.
- Ensure appropriate egress rules are created for two-way traffic.
- Network component for mount target: Locate the compartment where the
desired VCN is present for creating the mount target and in the
following drop-down field select an existing VCN and a subnet. Note: Allow TCP ports 111, 2048, 2049, 2050 and UDP ports 111, 2048 from the SCM instance subnet.
- "Use existing File system and Mount Target" option is provided to allow
the user to bring existing resources instead of SCM to create the mount
target and file system service. When this option is chosen user has to
provide value for the IP address of the mount target. Note: The existing file system export is to be provided in the subsequent section as below when "Use existing File system and Mount Target" is chosen.
- Network component for SCM Instance: Locate the compartment where the
desired VCN is present for creating the SCM instance and in the
following drop-down field select an existing VCN and a subnet.
-
When the "Use Existing Resources" or "Use existing File system and Mount Target" option is not selected in step 7, then under Storage, select the availability domain for storage in which the shared mount target and file storage is created. The options are 1, 2, or 3.
When the "Use Existing Resources" or "Use existing File system and Mount Target" is chosen provide value of Export path for the desired the file storage which will be used as persistence storage for SCM application.
-
Under SCM Instance Configuration, specify the shape of the SCM instance (the SCM Instance Type), the number of OCPU cores required, the memory in gigabytes, and whether the SCM instance uses a private IP address (the default) or a public IP address.
Note: Assigning a public IP for SCM configures the network for public access. Not assigning a public IP configures the network for private access only. Switching between public and private access is not supported.- HTTP PROXY: Provide your HTTP Proxy Server URL for HTTP requests.
For example - yourhttpproxyserver.com:80
- HTTPS PROXY: Provide your HTTPS Proxy Server URL for HTTPS requests.
For example - yourhttpsproxyserver.com:80
- URLs to bypass: Provide the list of URLs which needs to bypassed from
the Proxy server(no_proxy).
For example - externalurl1.com,externalurl2.com
Consider all the URLs which might / might not have access through your Proxy server during the provisioning of SCM and Siebel CRM environment. The provided HTTP_PROXY, HTTPS_PROXY, and NO_PROXY variables are applied only to SCM container as environment variables, and not to the whole docker configuration.
- HTTP PROXY: Provide your HTTP Proxy Server URL for HTTP requests.
- Optionally provide information about the security protocol (HTTP or HTTPS) and
corresponding port numbers to use for interacting with SCM over APIs. When HTTPS
mode is selected, choose whether to use SSL/TLS certificates of your choice
(CA-signed/self-signed/other options) in PEM format. Else, SCM will provision
and use a self-signed certificate. The certificates can be changed later.
If no choice is made regarding the security protocol, HTTPS will be the default protocol to interact with SCM, and a self-signed certificate will be automatically provisioned for use.
-
Under Network Configuration:
- If "Use Existing Resources" is selected in step 7, then you will be prompted to provide existing VCN details, such as the VCN Compartment OCID where VCN resides, and the VCN Name and Subnet where the SCM instance should be created.
- If "Use Existing Resources" is not selected in step 7, then you need to
specify whether you want to use Advanced Network Configuration to manage
the IP address ranges for the subnets for your SCM instance and Siebel
CRM deployments. Use this option only if you want to override the
default settings of /16 VCN and /24 Subnet Classless Inter-Domain
Routing (CIDR) block ranges. If you specify Advanced Network
Configuration, then you can modify the default settings of 10.0.0.0/16
for the IP range for the VCN CIDR block, 10.0.0.0/24 for the IP range
for the SCM subnet CIDR block, and 10.0.255.0/24 for the IP range for
the SCM private subnet CIDR block.
For details, see Using Advanced Network Configuration.
-
Under "Key Management", the user can choose to opt for the creation of a new vault provisioned by SCM or use an existing OCI Vault by passing Vault OCID or choose not to use any vault.
If "Use existing resources" is NOT selected, you can:- Allow SCM to create a new Vault by selecting "Create a new Vault".
- Attach an existing OCI Vault by passing the Vault OCID by selecting "Enter OCID of your existing Vault".
- Choose to opt for no Vault by selecting "Do Not Use Vault".
If "Use existing resources" is selected, you can only:- Attach an existing OCI Vault by passing the Vault OCID by selecting "Enter OCID of your existing Vault".
- Choose to opt for no Vault by selecting "Do Not Use Vault".
The creation of the new vault is only applicable when the "Use Existing Resources" is not selected.
Note: Oracle recommends using OCI Vaults to conform to best practices regarding managing secrets. For more information about the best practices for secrets management, see Using Vault for Managing Secrets. -
Choose Run Apply and then click Create to create the stack. Terraform scripts run which define the configuration for the new stack.
-
Wait for the completion of the Apply job. If an error such as
authorization failed
orrequested resource not found
appears, then choose Run Apply again. -
Make a note of the following URLs provided at the end of the run log:
- CloudManagerApplication. The URL for running SCM, which uses the
public or private IP address and port number of the newly created
instance. You will use this URL to run SCM, as described in Reducing the Ingress Range for Siebel Cloud Manager.
For example:
https://<CM_instance_IP>:<port_num>/
-
CloudManagerLiftUtilityDownload. The URL for downloading the Siebel Lift utility ZIP file. These links use the same IP address and port number. You will use this utility in your Siebel CRM on-premises environment, as described in Downloading and Running the Siebel Lift Utility.
Use a link like this for the container version of the download file:
https://<CM_instance_IP>:<port_num>/scm/api/v1.0/download/siebelliftutility_container.zip
Use a link like this for the non-container version of the download file:
https://<CM_instance_IP>:<port_num>/scm/api/v1.0/download/siebelliftutility.zip
- CloudManagerApplication. The URL for running SCM, which uses the
public or private IP address and port number of the newly created
instance. You will use this URL to run SCM, as described in Reducing the Ingress Range for Siebel Cloud Manager.
For example:
-
To verify the running status of the application, run
ssh
in the SCM VM instance and check thesystemctl
status for siebel-cloud-manager, as follows:ssh opc@[CM_instance_IP]
-
To verify the SCM application is running, run the following commands:
docker ps docker logs -t cloudmanager -f
-
To check the response, launch the following URL:
https://<CM_instance_IP>:<port_num>/
If you are performing a greenfield deployment, then you are now ready to create an environment using SCM. Otherwise, you must first download and run the Siebel Lift utility, as described in Downloading and Running the Siebel Lift Utility, before you can create an environment using the lifted artifacts in the OCI Object Store.