The Coherence command line interface (CLI) is a lightweight tool, in the tradition of tools such as kubectl


logo

Coherence CI License Go Report Card GitHub release (latest by date)

Coherence Command Line Interface (CLI)

Coherence Demo

Contents

Overview

The Coherence command line interface, cohctl, is a lightweight tool, in the tradition of tools such as kubectl, which can be scripted or used interactively to manage and monitor Coherence clusters. You can use cohctl to view cluster information such as services, caches, members, etc, as well as perform various management operations against clusters.

The CLI accesses clusters using the HTTP Management over REST interface and therefore requires this to be enabled on any clusters you want to monitor or manage. See the Coherence Documentation for more information on setting up Management over REST.

NOTE: The CLI does not replace current management and monitoring tools such as the Coherence VisualVM Plugin, Enterprise Manager, or Grafana Dashboards, but compliments and provides a lightweight and scriptable alternative.

Why use the Coherence CLI?

The CLI compliments your existing Coherence management tools and allows you to:

  • Interactively monitor your Coherence clusters from a lightweight terminal-based interface
  • Monitor service "StatusHA" during rolling restarts of Coherence clusters
  • Script Coherence monitoring and incorporate results into other management tooling
  • Output results in various formats including text, JSON and utilize JsonPath to extract attributes of interest
  • Gather information that may be useful for Oracle Support to help diagnose issues
  • Connect to standalone or WebLogic Server based clusters from commercial versions 12.2.1.4 and above as well as all Coherence Community Edition (CE) versions
  • Retrieve thread dumps across members

Install the CLI

Note: The Coherence CLI is currently in pre-release and the latest version is 1.0.0-RC1.

The Coherence CLI is available as a binary for most platforms and architectures. See the Install guide for information on downloading the CLI.

Getting Started

Documentation for the Coherence CLI is available here

The fastest way to experience the Coherence CLI is to follow the Quick Start guide.

Supported Coherence Versions

The CLI supports and is certified against the following Community and Commercial editions of Coherence:

Coherence Community Edition

  • 21.12
  • 21.06.x
  • 20.12.2 (JFR commands are not supported)
  • 14.1.1-0-x

Coherence Grid/ Enterprise Edition

  • 12.2.1.4.x - minimum patch level of 12.2.1.4.7+ required
  • 14.1.1.0.x - minimum patch level of 14.1.1.0.2+ required

Note: If you are on a patch set below the minimum recommended above, then CLI may work, but some functionality may not be available. It is always recommended to upgrade to the latest Coherence patch as soon as you are able to.

Need more help? Have a suggestion? Come and say "Hello!"

We have a public Slack channel where you can get in touch with us to ask questions about using the Coherence CLI or give us feedback or suggestions about what features and improvements you would like to see. We would love to hear from you. To join our channel, please visit this site to get an invitation.
The invitation email will include details of how to access our Slack workspace. After you are logged in, please come to #cli and say, "hello!"

Similar Resources

colorizes kubectl output

colorizes kubectl output

kubecolor Colorize your kubectl output get pods describe pods something wrong You can change color theme for light-backgrounded environment What's thi

Jan 8, 2023

kubectl plugin for signing Kubernetes manifest YAML files with sigstore

kubectl plugin for signing Kubernetes manifest YAML files with sigstore

k8s-manifest-sigstore kubectl plugin for signing Kubernetes manifest YAML files with sigstore ⚠️ Still under developement, not ready for production us

Nov 28, 2022

A kubectl plugin for finding decoded secret data with productive search flags.

kubectl-secret-data What is it? This is a kubectl plugin for finding decoded secret data. Since kubectl only outputs base64-encoded secrets, it makes

Dec 2, 2022

A 'kubectl' plugin for interacting with Clusternet.

kubectl-clusternet A kubectl plugin for interacting with Clusternet. Installation Install With Krew kubectl-clusternet can be installed using Krew, pl

Aug 14, 2022

kubetnl tunnels TCP connections from within a Kubernetes cluster to a cluster-external endpoint, e.g. to your local machine. (the perfect complement to kubectl port-forward)

kubetnl kubetnl (kube tunnel) is a command line utility to tunnel TCP connections from within a Kubernetes to a cluster-external endpoint, e.g. to you

Dec 16, 2022

Kubectl plugin to run curl commands against kubernetes pods

kubectl-curl Kubectl plugin to run curl commands against kubernetes pods Motivation Sending http requests to kubernetes pods is unnecessarily complica

Dec 22, 2022

A kubectl plugin for finding decoded secret data with productive search flags.

kubectl-secret-data What is it? This is a kubectl plugin for finding decoded secret data. Since kubectl outputs base64-encoded secrets basically, it m

Dec 2, 2022

A kubectl plugin for getting endoflife information about your cluster.

A kubectl plugin for getting endoflife information about your cluster.

kubectl-endoflife A kubectl plugin that checks your clusters for component compatibility and Kubernetes version end of life. This plugin is meant to a

Jul 21, 2022

A kubectl plugin to evict pods

kubectl-evict A kubectl plugin to evict pods. This plugin is good to remove a pod from your cluster or to test your PodDistruptionBudget. 💿 Installat

Dec 7, 2022
Kubectl golang - kubectl krew template repo

kubectl krew template repo There's a lot of scaffolding needed to set up a good

Jan 11, 2022
Hexagonal architecture paradigms, such as dividing adapters into primary (driver) and secondary (driven)Hexagonal architecture paradigms, such as dividing adapters into primary (driver) and secondary (driven)

authorizer Architecture In this project, I tried to apply hexagonal architecture paradigms, such as dividing adapters into primary (driver) and second

Dec 7, 2021
This plugin helps you to use the AWS Command Line Interface (AWS CLI) to start and end sessions to your managed instances

Session Manager Plugin This plugin helps you to use the AWS Command Line Interface (AWS CLI) to start and end sessions to your managed instances. Sess

Dec 28, 2022
Jan 4, 2022
Simple tool to generate dockerconfigjon. This use snippets from kubectl.

gen-dockercfg Simple tool to generate dockerconfigjon. This use snippets from kubectl. Usage: gen-dockercfg -email string Registry email -pas

Jan 7, 2022
Command line tools for usedevbook.com

dbk dbk is a command-line tool (CLI) for usedevbook.com. It allows you to build and push custom environments for Devbook VMs. You can then launch Devb

Feb 21, 2022
Command Line Interface for Scaleway
Command Line Interface for Scaleway

Scaleway CLI (v2) Scaleway CLI is a tool to help you pilot your Scaleway infrastructure directly from your terminal. Installation With a Package Manag

Jan 3, 2023
🏯 Monitor your (gitlab/github) CI/CD pipelines via command line interface with fortress
🏯 Monitor your (gitlab/github) CI/CD pipelines via command line interface with fortress

__ _ / _| | | | |_ ___ _ __| |_ _ __ ___ ___ ___ | _/ _ \| '__| __| '__/ _ \/ __/ _

Mar 31, 2022
Generic inquiry tool to OPA server for CI process, such as GitHub Actions

opaq opaq is a generic inquiry tool to OPA server. A major purpose of this tool is for inquiry in GitHub Actions. Features Data formatting: OPA server

Jan 20, 2022
Kubectl plugin to ease sniffing on kubernetes pods using tcpdump and wireshark
Kubectl plugin to ease sniffing on kubernetes pods using tcpdump and wireshark

ksniff A kubectl plugin that utilize tcpdump and Wireshark to start a remote capture on any pod in your Kubernetes cluster. You get the full power of

Jan 4, 2023