To use IBM Instana® Observability with
IBM® Software
Hub, you must install the Instana® host agent on your Red Hat®
OpenShift® Container Platform cluster.
- Who needs to complete this task?
-
Cluster administrator A cluster administrator
must complete this task.
- When do you need to complete this task?
-
One-time setup The Instana host agent is installed once and can
be used by all instances of IBM Software
Hub on the
cluster.
Before you begin
To install the Instana host agent
on your cluster, you must have Helm 3 on
the client workstation from which you will run the installation commands.
Best practice: You can run many of the
commands in this task exactly as written if you set up environment variables for your installation.
For instructions, see
Setting up installation environment variables.
Ensure that you source the
environment variables before you run the commands in this task.
About this task
The Instana host agent on the
cluster sends data to the Instana
backend.
This task assumes that you have an existing
Instana backend that you want to connect to.
For more information, see the following topics in the
IBM
Instana Observability documentation:
Procedure
- Sign in to the Instana
interface. From the home page click Deploy Agent.
- Click OpenShift Helm Chart.
- In the Cluster name field , specify the name that you want to use
to identify the IBM Software
Hub deployment from
Instana.
- Optional: If you use zone grouping, select the zone that this cluster is in
from the Agent zone drop down menu.
- Copy the
helm install instana-agent command from the Instana interface and save the command to a
text file. The command has the following format:
helm install instana-agent \
--repo https://agents.instana.io/helm \
--namespace ${INSTANA_AGENT_NAMESPACE} \
--set agent.key='<your_agent_key>' \
--set agent.endpointHost='<your_host_agent_endpoint>' \
--set agent.endpointPort=443 \
--set cluster.name='<your_cluster_name>' \
--set zone.name='<your_zone_name>' \
instana-agent
If you did not specify an agent zone, the command does not include the --set
zone.name option.
- Log in to Red Hat
OpenShift Container Platform as a user with sufficient permissions to
complete the
task.
${OC_LOGIN}
Remember:
OC_LOGIN is an alias for the oc login command.
- Create the project (namespace) where you want to install the agent.
The
recommended name is
instana-agent.
oc new-project instana-agent
- Assign the
privileged security context constraint (SCC) to the
instana-agent service account:
oc adm policy add-scc-to-user privileged \
-z instana-agent \
-n instana-agent
- Assign the
anyuid SCC to the instana-agent-remote
service account:
oc adm policy add-scc-to-user anyuid \
-z instana-agent-remote \
-n instana-agent
- Copy the
helm install instana-agent command from the text file and run
the command.
- Wait for the installation to complete.
- Print the
- Edit the
instana-agent config map:
oc edit cm instana-agent \
-n instana-agent
- Add the following plug-in configurations to the
configuration.yaml:
section:
com.instana.sensor-redis:
enabled: false
com.instana.sensor-redis-enterprise:
enabled: false
com.instana.sensor-haproxy:
enabled: false
com.instana.plugin.redis:
enabled: false
- Save your changes to the config map.
For example, if you are using vi, hit esc and enter:
:wq
- Restart the agents:
oc rollout restart ds instana-agent \
-n instana-agent
What to do next
Now that you've installed the host agent, you're ready to complete Enabling Instana for IBM Software Hub.