node-topology

README

kubectl-topology

This is a kubectl plugin to view the topology of CPU and device resources on the current node. kubectl topology uses the local CPU Manager and Device Manager checkpoint files to access resource information. Therefore this is a node level application and the plugin is limited to the node on which you are logged in.

Configuration

The paths for CPU Manager and Device Manager checkpoint files are located in kubectl-topology-config.yaml. By default, these paths are set to /var/lib/kubelet/cpu_manager_state and /var/lib/kubelet/device-plugins/kubelet_internal_checkpoint respectively. If these paths differ on your Kubernetes node, you need to set the proper paths and save the file to $HOME/.kubectl-topology-config.yaml.

Installation

Ensure your Go environment and $GOPATH is configured correctly

• cd $GOPATH/src/github.com
• mkdir nolancon && cd nolancon
• git clone https://github.com/nolancon/kubectl-topology && cd kubectl-topology
• go get ./...
• go build -o /usr/bin/kubectl-topology

Usage

• Display topology of CPU and device resources for the current node: kubectl topology node
• Display topology of assigned CPUs and devices for all pods on current node consuming CPU and/or devices: kubectl topology pod
• Display topology of assigned CPUs and devices for a specified pod: kubectl topology pod <pod-name>
• Help kubectl topology --help kubectl topology node --help kubectl topology pod --help

  Note: Only pods on the current node, consuming CPU and/or device resources will be considered by the plugin.

Documentation

Overview

Copyright © 2019 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.