Get Started

Get Started#

GitHub Actions, via this project’s Continuous Delivery workflow, automates deployments, but if necessary, follow these instructions to deploy the project manually.

Required Software#

Install and configure the following software before deploying the components of this project.

Docker

Docker is an open platform for developing, shipping, and running applications. Docker allows you to separate your applications from your infrastructure so you can deliver software quickly. With Docker, you can manage your infrastructure in the same ways you manage your applications.

Guidance

Manual deployers only need Docker if they need to push updated images to the cortex-meta OCI image registry.

Git

Tracks changes to source code or data, with support for distributed, non-linear workflows. Deployers need read access to the referenced Git repositories. When using SSH to connect to private remote repositories, set url.<base>.insteadOf in the global Git configuration to transparently map HTTPS URLs used by this project to SSH URLs.

Helm

Helm helps you manage Kubernetes applications. Helm Charts help you define, install, and upgrade even the most complex Kubernetes application.

Kubectl

The Kubernetes command-line tool, kubectl, allows you to run commands against Kubernetes clusters. You can use kubectl to deploy applications, inspect and manage cluster resources, and view logs.

Deployers need administrator access to the target Kubernetes cluster. Refer to the Cortex-meta documentation for authentication and configuration guidance. Note that this project deploys resources in RENU data center by default.

Manual Deployment Procedure#

  1. Clone this GitHub repository. Alternatively, download and unpack the latest release.

  2. If the LDAP and Discovery images are not available in the cortex-meta OCI image registry, build and push them to the registry.

docker build --platform linux/amd64 \
  -f charts/cortex/config/discovery/image/Dockerfile.httpd \
  -t zot.cluster.ibrst.org/cortex/httpd:2.4.67 \
  charts/cortex/config/discovery/image \
  && docker push zot.cluster.ibrst.org/cortex/httpd:2.4.67

  1. Download the kubernetes cluster config from the credential vault, saving it to your kubernetes configuration file e.g ~/.kube/config.

  2. Download the chart values from the credential vault, saving it to the project root directory.

  3. Install or upgrade the CORTEX Helm chart to deploy the platform components.

    helm upgrade --install cortex charts/cortex \
-n cortex-dev --create-namespace \
-f my-values.yaml