Skip to content

Latest commit

 

History

History
186 lines (125 loc) · 7.22 KB

manual-install.md

File metadata and controls

186 lines (125 loc) · 7.22 KB
Raw

Manual Installation

If you want to install metering without OLM, using what's currently in master, first start by cloning the repo. Next, decide which namespace you want to install Metering into, and set the METERING_NAMESPACE environment variable to the namespace you want to use. By default, if it's unset, it will use the metering namespace.

Versioning

By default, a manual install will deploy the latest build of master. If you want to use a specific version, checkout a git tag for the version you want to use before installing, or follow the instructions for installing with a custom metering operator image.

Requirements

Our installation scripts are written in bash, and utilize a few non-standard tools to interact with yaml and json files. Please ensure you have the following tools installed before running the install scripts:

Install

Depending on your Kubernetes platform (regular Kubernetes, or Openshift)

For a standard Kubernetes cluster:

$ export METERING_NAMESPACE=metering-$USER
$ ./hack/install.sh

If you're using Openshift, use openshift-install.sh:

$ export METERING_NAMESPACE=metering-$USER
$ ./hack/openshift-install.sh

Uninstall

To uninstall the process is the same, pick the right uninstall script for your platform, and run it.

For a standard Kubernetes cluster:

$ export METERING_NAMESPACE=metering-$USER
$ ./hack/uninstall.sh

If you're using Openshift, use openshift-uninstall.sh:

$ export METERING_NAMESPACE=metering-$USER
$ ./hack/openshift-uninstall.sh

Customize installation

If you wish to customize the installation, such as to modify configuration options, change the image tag or repository, then you can use a custom metering resource. To start, copy the default metering resource to a separate file that we can modify:

$ cp manifests/metering-config/default.yaml metering-custom.yaml

For developers, the most common change is modifying the image tag, config, and resource limits. Take a look at the common configuration docs to get an idea of what you can modify that relates to configuration and resource limits, and manifests/metering-config/latest-versions.yaml to see how to change the image tag of each component.

$ export METERING_NAMESPACE=metering-$USER
$ export METERING_CR_FILE=metering-custom.yaml

Then run the installation script for your platform:

  • ./hack/install.sh
  • ./hack/openshift-install.sh

For more details on configuration options, most are documented in the configuring metering document.

Install with a custom metering operator image

You can override the metering-operator image using a combination of 3 environment variables:

Set METERING_OPERATOR_IMAGE_REPO to the image repository you wish to use, and set METERING_OPERATOR_IMAGE_TAG to the image tag you want. If you only want to change the image tag, then leave METERING_OPERATOR_IMAGE_REPO unset.

For example:

export METERING_OPERATOR_IMAGE_REPO=internal-registry.example.org:6443/someorg/metering-helm-operator
export METERING_OPERATOR_IMAGE_TAG=0.13.0
./hack/openshift-install.sh

You can also it in a single line:

METERING_OPERATOR_IMAGE_TAG=pr-123 ./hack/openshift-install.sh

Run reporting operator locally

It's also possible to run the operator locally. To simplify this, we've got a few Makefile targets to handle the building and running of the operator.

First, we still need to run Presto, Hive, and HDFS in the cluster, and also set reporting-operator replicas to 0 so that our local operator can obtain the leader election lease when we start it.

To do this, update your metering-custom.yaml to set spec.reporting-operator.replicas to 0 like so:

spec:
  reporting-operator:
    replicas: 0

Next, run the install script for your platform (see above).

After running the install script, figure out where your Prometheus pod is running. By default the run-reporting-operator-local Makefile target assumes that the pod is in the openshift-monitoring namespace and can be queried using the label selector app=prometheus.

If your Prometheus is located somewhere else, you can override the defaults using the environment variables METERING_PROMETHEUS_NAMESPACE and METERING_PROMTHEUS_LABEL_SELECTOR to the namespace your Prometheus pod is in, and the label selector for querying Prometheus. Alternatively, if you wish to specify your Prometheus with a host, set METERING_PROMETHEUS_PORT_FORWARD to false and METERING_PROMETHEUS_HOST to the host/port of your instance.

Ex (these are the defaults):

export METERING_PROMETHEUS_NAMESPACE=openshift-monitoring
export METERING_PROMTHEUS_LABEL_SELECTOR=app=prometheus

Finally, use the following command to build & run the operator:

make run-reporting-operator-local

The above command builds the operator for your local OS (by default it only builds for Linux), uses kubectl port-forward to make Prometheus, Presto, and Hive available locally for your operator to communicate with, and then starts the operator with configuration set to use these local port-forwards. Lastly, the operator automatically uses your $KUBECONFIG to connect and authenticate to your cluster and perform Kubernetes API calls.

Run metering operator locally

The metering operator is the top-level operator which deploys other components using helm charts. It's possible to also run this locally so you can iterate on charts and test them with the metering-operator before they're built and pushed to Quay for CI.

To run it locally you need to have the following:

  • A connection to a docker daemon.
  • Your $KUBECONFIG environment variable must be set and accessible to your Docker daemon.
  • Your $METERING_NAMESPACE environment variable must be set, and unless $LOCAL_METERING_OPERATOR_RUN_INSTALL to true, the namespace must already exist.

This will just build and run the metering-operator docker image, which will watch for Metering resources in the namespace specified by $METERING_NAMESPACE, using your $KUBECONFIG to communicate with the API server.

make run-metering-operator-local

Install the most recent version available in OLM

There is set of scripts for install/uninstall that automate using the latest version of the metering package in OLM: hack/olm-install.sh and hack/olm-uninstall.sh. These scripts work similarly to the hack/install.sh and hack/uninstall.sh scripts, except they install using OLM.

Set your METERING_NAMESPACE and METERING_CR_FILE then run the script:

./hack/olm-install.sh

To uninstall:

./hack/olm-uninstall.sh

Note: You must run the olm-uninstall.sh script to uninstall. Not doing may result in inability to re-install correctly.

For more details on what this is doing, see the OLM install guide