Skip to main content

Install the Ocean Network Client in the Cluster

Cloud service provider relevance AWS Kubernetes

This tutorial describes installing the Ocean Network Client as a DaemonSet in your Ocean-managed Kubernetes cluster. In order to measure Network Costs for container or Kubernetes workloads, the Ocean network client needs to run with privileged access on every node in the cluster.

There are several options to install the Ocean Network Client listed below.

After installing the Network Client, it may take 1-2 hours for the Network Costs column to appear in the Spot console or for the oceanK8sClusterAggregatedDetailedCosts API to show the network costs breakdown.

Prerequisites​

  • The Ocean controller must be installed and run correctly.
  • The Ocean network client should be installed in the same namespace (typically kube-system) as the Ocean Kubernetes controller.
  • The Ocean network client can be installed using Helm version 3 and later. Not supported with Helm 2.x.
  • The Ocean network client uses eBPF TC and requires nodes with Linux v4.18 kernel or later. Not supported on Windows nodes.

Supported Operating Systems​

The Ocean Network Client is supported on Linux and requires Linux kernel version of 4.18 or later. For example:

  • EKS with AWS Linux 2 AMI
    • Kubernetes 1.23 and below: Linux v5.4 kernel
    • Kubernetes 1.24 and above: Linux 5.10 kernel
  • Ubuntu
    • 18.4 (Linux v5.4 kernel)
    • 20.4 (Linux v5.14 kernel)
  • RHEL 8.x
  • CentOS 8.x

Installation Considerations​

The following are some considerations when installing the Ocean network client:

  • Ocean network client requires privileged access and system capabilities (SYS_ADMIN, NET_ADMIN) to allow the client to attach pod and host network port on each node.

    • Linux kernel v5.8, does not require SYS_ADMIN capability. The capabilities can be reduced to CAP_BPF and NET_ADMIN.

  • Ocean network client runs as a DaemonSet on every node in the cluster. In most cases the network client requires a minimal amount of compute (CPU and memory) overhead. Actual resources needed depend on cluster size, number of flows and data transfer interval (default 60s).

    • Resource requests: 10m vCPU (1% CPU) and ~100MiB
    • Resource limits: 300m vCPU and ~500MiB

  • The network client uses a lightweight eBPF program based on TC BPF to capture traffic flow data (IP addresses, protocols TCP/UDP ports, transmitted TX and received RX packet and byte counts) in and out of the pods with minimum impact to existing workloads.

  • Flow data on each node is aggregated, compressed before it is sent to the Ocean backend cluster. This could result in some minimal data transfer cost overhead, typically $10 per month per cluster. Actual data transfer costs depend on cloud provider pricing, number of nodes, number of flows and data transfer interval.

Install or Update the Ocean Network Client with Helm​

This procedure describes installing or upgrading the Ocean Network Client DaemonSet using Helm. Installation is only supported with Helm version 3.x (not supported with Helm 2.x). To learn more at Ocean Network Client hem chart Ocean Network Client Helm chart.

Install the Ocean network client for the first time with Helm 3.x​

  1. Add the Spot Helm chart repository https://charts.spot.io using command: helm repo add.

  2. Update the local Helm chart repository cache using command helm repo update, so that it includes Spot repo spot/ocean-network-client.

  3. Install the Ocean network client, using command helm repo install.

  helm install my-release spot/ocean-network-client \
    --set spotinst.account=$SPOTINST_ACCOUNT \
    --set spotinst.clusterIdentifier=$SPOTINST_CLUSTER_IDENTIFIER \
    --set spotinst.token=$SPOTINST_TOKEN \
    --namespace <$NAMESPACE> --set namespace=<$NAMESPACE>
note

Configure all required chart values using the set command line argument or a values.yaml file.

Update the Ocean network client version with Helm 3.x​

  1. Discover all the available released Ocean network client versions using command helm search.

  2. Then, upgrade to a specific or latest version from the list above using the command: helm upgrade.

    helm upgrade my-release spot/ocean-network-client \
     --namespace <$NAMESPACE>

Install or Update the Ocean Network Client with Terraform​

Use Terraform Ocean Network Client module to install and manage the network client.
Use the example below to install or update to the latest network client version using Terraform. Set the version to the latest Ocean network client module available in the Spot Terraform registry.

Usage example for Ocean network client module:

provider "helm" {
  kubernetes {
    config_path = "~/.kube/config"
  }
}

module "ocean-network-client" {
  source  = "spotinst/ocean-network client/spotinst"
  version = "<LATEST_VERSION>"
}

Install the Ocean Network Client with Controller Init Script​

The Init script (init.sh) installs the Ocean Kubernetes controller in the cluster. Using the Init script (init.sh) option to install the Ocean Network Client can only be done when creating a new Ocean cluster or importing a new Kubernetes cluster to Ocean.

To enable the Ocean Network client in the new Ocean managed cluster, set ENABLE_OCEAN_NETWORK_CLIENT=true in the Ocean controller init.sh script.

Enable or check the' ENABLE_OCEAN_NETWORK_CLIENT' variable in the Create or Import cluster wizard using the Spot console.

curl -fsSL https://spotinst-public.s3.amazonaws.com/integrations/kubernetes/cluster-controller/scripts/init.sh | \
SPOTINST_TOKEN=<TOKEN> \
SPOTINST_ACCOUNT=<ACCOUNT> \
SPOTINST_CLUSTER_IDENTIFIER=<CLSUTER_ID> \
ENABLE_CSR_APPROVAL=true \
ENABLE_OCEAN_METRIC_EXPORTER=true \
ENABLE_OCEAN_NETWORK_CLIENT=true

Upgrade the Network Client After Ocean Controller Upgrade V1 to V2​

Select the upgrade option that fits your needs:

Option 1: Upgrade Without Ocean Controller Secret and Configmap​

Use this option if you want to upgrade your network client.


helm upgrade my-release spot/ocean-network-client \
  --set spotinst.account=$SPOTINST_ACCOUNT \
  --set spotinst.clusterIdentifier=$SPOTINST_CLUSTER_IDENTIFIER \
  --set spotinst.token=$SPOTINST_TOKEN \
  --namespace <$NAMESPACE> --set namespace=<$NAMESPACE>

Option 2: Upgrade With Ocean Controller Secret and Configmap (Controller V2 and Network Client Installed in Same Namespace)​

Update the yaml with secret and config map:


helm upgrade my-release spot/ocean-network-client \
  --set secretName=$SECRET_NAME \
  --set configMapName=$CONFIG_MAP_NAME \
  --namespace <$NAMESPACE>

Option 3: Upgrade With Ocean Controller Secret and Configmap (Controller V2 and Network Client Installed in Different Namespaces)​

Remove the previous agent, install and configure a new agent, and create a new namespace:


helm install my-release spot/ocean-network-client \
  --set secretName=$SECRET_NAME \
  --set configMapName=$CONFIG_MAP_NAME \
  --namespace <$NAMESPACE> --set namespace=<$NAMESPACE>