About Installing the TimesTen Operator

There are YAML manifest files and Helm charts for installing the TimesTen Operator. A TimesTen container image contains these files and charts. To find out how to obtain these files and charts, see Obtain TimesTen YAML Manifest Files and Helm Charts.

The YAML manifest files and Helm charts for installing the TimesTen Operator in a namespace in your Kubernetes cluster at namespace-scope are different than the files for installing the TimesTen Operator in the timesten-operator namespace in your Kubernetes cluster at cluster-scope. For information about these scopes, see About the TimesTen Operator.

Note:

You must install the TimesTen Operator in either one or more namespaces in your cluster at namespace-scope or in the timesten-operator namespace in your cluster at cluster-scope. You cannot install in both scopes.
To install the TimesTen Operator in a namespace in your Kubernetes cluster at namespace-scope, you can use either YAML manifest files or a Helm chart:

  • To install using YAML manifest files, use the following files:

    • service_account.yaml: Defines the RoleBinding, Role, and ServiceAccount objects that are necessary for the TimesTen Operator to run properly in a namespace in your cluster at namespace-scope. The service account requires a set of defined privileges and permissions, which are granted through a role. A role binding assigns a role to a service account. See About Privileges.

    • service_account_cluster.yaml: Defines additional privileges and permissions for the TimesTen Operator. Although not mandatory, we recommend that you install this file. It defines the privileges and permissions that are required if you want the TimesTen Operator to delete TimesTen Pods and PVCs when detecting a node failure. For more information about this feature, see How the TimesTen Kubernetes Operator Handles Node Failure.

    • operator.yaml: Defines the Deployment that is used to run the TimesTen Operator in a namespace in your cluster at namespace-scope. There are customizations for this Deployment. See About Customizations for a TimesTen Operator Deployment.

  • To install using a Helm chart, use the ttoperator Helm chart. See Use Helm in Your TimesTen Kubernetes Operator Environment and The ttoperator Chart.

To install the TimesTen Operator in the timesten-operator namespace in your Kubernetes cluster at cluster-scope, you can use either YAML manifest files or a Helm chart:

  • To install using YAML manifest files, use the following files:

    • cluster_config.yaml: Defines the timesten-operator namespace as well as the ServiceAccount, Role, RoleBinding, ClusterRole, and ClusterRoleBinding objects necessary to run the TimesTen Operator in the timesten-operator namespace at cluster-scope. For more information about these objects, see About Privileges.

    • cluster_operator.yaml: Defines the Deployment that is used to run the TimesTen Operator in the timesten-operator namespace in your cluster at cluster-scope. There are customizations for this Deployment. See About Customizations for a TimesTen Operator Deployment.

  • To install using a Helm chart, use the ttclusteroperator Helm chart. See Use Helm in Your TimesTen Kubernetes Operator Environment and The ttclusteroperator Chart.

There are examples in this chapter that show you how to install the TimesTen Operator in a namespace in your Kubernetes cluster at namespace-scope and in the timesten-operator namespace in your Kubernetes cluster at cluster-scope using YAML manifest files. To install using Helm charts, see Use Helm in Your TimesTen Kubernetes Operator Environment.

Note:

Most of the examples in the book assume you have installed the TimesTen Operator in a namespace in your Kubernetes cluster at namespace-scope. If there are cases where the TimesTen Operator is installed in the timesten-operator namespace in your Kubernetes cluster at cluster-scope, the documentation points this out.