Generating simple custom resource and deployment files
Before you begin
- To set up and configure your directory server, see Preparing the P8 Platform directory server.
- To prepare your database to support the FileNet P8 Platform components in a container environment, see Preparing the databases.
- To use storage classes and to create all the needed volumes for your deployment, see Storage considerations.
- To set up admin users and groups for proper administration and access control within the deployment, see Creating Content Platform Engine directory server accounts.
The prerequisites.py script uses the following utility tools and needs them to be installed on your client machine.
- Kubernetes CLI
- Python
container-samples
repository from GitHub- Java™
If the script finds that any of these tools are missing on the client, it reports which tools are missing and provides a choice to install the tool.
About this task
Instead of going through the many documented steps to create the databases and secrets for the components in your deployment, you can use the script to generate the SQL templates that assist in creating the databases and YAML files to utilize when creating the Kubernetes secrets.
The prerequisite scripts also generate a simple custom resource that includes all the essential elements that are necessary for a deployment. By default, it includes Content Pattern and deploys the Content Platform Engine, GraphQL, and Navigator components.
After you generate the custom resource, you can add additional configuration according to your specific requirements.
The prerequisites.py script has three modes.
- gather
-
The
gather
mode helps gather information about your desired deployment. When you run the script in gather mode, it creates property files that you need to fill. The gather command comes with two options: new or move. - generate
- The
generate
mode generates the DB SQL statement files, Kubernetes secrets YAML files, and the custom resource YAML template based on the gathered information from the property files. - validate
- The
validate
mode checks whether the generated databases and secrets are correct and ready to use in a container deployment. It also validates the connections to external services and the usage of storage classes along with the option to continue with the process and create the deployment by applying the custom resource YAML file.
After you downloaded the container-samples repository, change the directory to the container-samples/scripts folder.
The script can be run from this location and has the following options:
python3 prerequisites.py --help
Usage: prerequisites.py [OPTIONS] COMMAND [ARGS]...
FileNet Content Manager Deployment Prerequisites CLI.
Options:
--version Show version and exit.
--help Show this message and exit.
Customization and Utils:
--silent --no-silent Enable Silent Install (no prompts). [default: no-silent]
--verbose --no-verbose Enable verbose logging. [default: no-verbose]
--dryrun --no-dryrun Perform a dry run [default: no-dryrun]
Commands:
gather Gather the prerequisites for FileNet Content Manager Deployment.
generate Generate the prerequisites for FileNet Content Manager Deployment.
validate Validate the prerequisites for FileNet Content Manager Deployment.
python3 prerequisites.py
python3 prerequisites.py --silent
By default the prerequisites script logs all errors to the console and to a file named prerequisites.log, in your working directory.
python3 prerequisites.py --verbose generate
Procedure
What to do next
- If you do not want to customize the generated simple custom resource, you can deploy the custom resource. For more information, see Deploying the custom resource.
- If you want to further customize and configure the generated simple custom resource, see Configuring an advanced custom resource.
- (Optional) If you do not want to use the generated custom resource, but rather want to create
your custom resource from the template available in the
container-samples
repository, see topic (Optional) Creating the custom resource from the CR template. - (Optional) If you do not want to use the generated custom resource, but rather want to use the OpenShift console to create and deploy your custom resource, see topic (Optional) Creating the custom resource in the OpenShift console