Releases: oracle/coherence-cli
Coherence CLI - 1.8.0
Coherence CLI Release 1.8.0
This is release 1.8.0 of the Coherence Command Line Interface (CLI).
For more information, see the README.
Installing
See here for installation instructions.
Upgrading
If you already have the CLI installed, you can run cohctl version -u
to see if you have the latest version.
Getting Started
To get started, visit the Coherence CLI documentation and follow the instructions to install and start using the CLI.
New Features
- Added the ability to sort table output by any column by using the
--sort
option followed by a column name. Sorting is ascending by default but can be changed to descending by using the--desc
flag. - Added the ability to add custom panels to be displayed with
cohctl monitor cluster
usingcohctl set/get panels
- Added the
--limit
option to be used with the-W
option to limit the number of lines displayed to the terminal size - Added the
cohctl run report
command to run a report interactively and return output in JSON format. Only available with the very latest patches of Coherence - Added the
cohctl restart cluster
command to restart an already running local cluster - added the ability to override the home directory where the client stores it’s files by specifying the
COHCTL_HOME
environment variable
Changes / Bugs Fixes
- The sorting columns in
cohctl get p2p-stats
have been removed as the above more flexible--sort
option can now be used - Changed
cohctl get http-servers
andcohctl get proxies
commands to show summary of the relevant servers - Added
cohctl get http-server-members
andcohctl get proxy-members
commands to show member details for each - Updated to support the latest Community Edition (CE) and commercial patches
- Minor updates to error messages to provide more clarity on single arguments
- Fixed an issue where the
get machines
command would show more machines that there actually are - ESC key can also be used to exit panel view in
cohctl monitor cluster
- Fixed an issue where
cohctl describe http-server
andcohctl describe proxy
would not correctly display the results - Fixed an issue where jsonpath output may not be processed correctly
- Fixed an issue where colour would not work correctly on Windows
Breaking Changes
- Federation commands have be standardised to use
outgoing
instead ofdestinations
andincoming
instead oforigins
- e.g.
cohctl get federation destinations
is nowcohctl get federation outgoing
- e.g.
Full List of Changes
- Prepare for next release by @tmiddlet2666 in #229
- Update CI/CD for 24.09 by @tmiddlet2666 in #230
- Add column sorting option to all tables by @tmiddlet2666 in #231
- Minor update to display cluster when specifying context by @tmiddlet2666 in #232
- Minor updates by @tmiddlet2666 in #233
- Minor changes to default layout by @tmiddlet2666 in #234
- Add custom panels for monitor cluster command by @tmiddlet2666 in #235
- Add option to limit table output to screen size by @tmiddlet2666 in #236
- Add roles and run report command by @tmiddlet2666 in #237
- Add restart cluster and update ci/cd by @tmiddlet2666 in #238
- Update README.md by @ghillert in #239
- Minor update to cache stores command by @tmiddlet2666 in #240
- Add the ability to specify the home directory for files using COHCTL_HOME by @tmiddlet2666 in #241
- Minor cosmetic and message updates by @tmiddlet2666 in #242
- Code cleanup for json and jsonpath output by @tmiddlet2666 in #243
- Fixed an issue where color was not correct on windows by @tmiddlet2666 in #244
- Update Trivy scan by @tmiddlet2666 in #245
- Update workflow versions by @tmiddlet2666 in #246
- Change the way get proxies and get http-proxies works by @tmiddlet2666 in #247
- Minor formatting for get cache-partitions by @tmiddlet2666 in #248
- Update to use trivy action by @tmiddlet2666 in #249
- Fix monitor cluster to protect against empty data by @tmiddlet2666 in #250
- Minor update to exclude special caches by @tmiddlet2666 in #251
- Update to build with go 1.22 by @tmiddlet2666 in #252
- Update version of x/net to v0.33.0 by @tmiddlet2666 in #254
New Contributors
Full Changelog: 1.7.2...1.8.0
Coherence CLI - 1.7.2
Introduction
This is release 1.7.2 of the Coherence Command Line Interface (CLI).
For more information, see the README.
Installing
See here for installation instructions.
Upgrading
If you already have the CLI installed, you can run cohctl version -u
to see if you have the latest version.
Getting Started
To get started, visit the Coherence CLI documentation and follow the instructions to install and start using the CLI.
Updates / Changes
- Command updates:
- Added
cohctl force recovery
to force persistence recovery
Warning: This operation may lead to the partial or full data loss of the corresponding cache service and should be used only in extreme circumstances as required - Added
cohctl get service-ownership
to show the primary and backup(s) ownership for a service
- Added
- Creating clusters
- Add the ability for cohql to connect via gRPC proxy, example
cohctl create cluster my-cluster -a coherence-grpc-proxy,coherence-java-client
cohctl start cohql -G
- Added the ability to specify
--rack
--machine
or--site
when creating, starting or scaling clusters
- Add the ability for cohql to connect via gRPC proxy, example
- Monitor clusters:
- Add default-federation and default-members panels
- Add option
-D
to disable padding on load
- Other Updates
- Updated to work with the latest Coherence CE and commercial releases and patches
Known Issues
- If you use the new command completion for services or caches, and your services or caches contains a $, then the completion may not work correctly
Please raise an issue here if you have any problems.
You can also join our public Slack Channel.
Full Change List
Full Changelog: 1.7.1...1.7.2
Coherence CLI - 1.7.1
Introduction
This is release 1.7.1 of the Coherence Command Line Interface (CLI).
For more information, see the README.
Installing
See here for installation instructions.
Upgrading
If you already have the CLI installed, you can run cohctl version -u
to see if you have the latest version.
Getting Started
To get started, visit the Coherence CLI documentation and follow the instructions to install and start using the CLI.
Updates / Changes
- Change the default for
monitor cluster
to be to display padding on - Update various dependencies including cobra
- Update default CE version to be 22.06.9
Dependency Updates
- Update to build with Go 1.21
- Update certification checks to include latest CE and commercial versions
Bug Fixes
- Fixed the CLI to correctly honour environment variables for setting proxy servers - see documentation for more information
Known Issues
- If you use the new command completion for services or caches that contain a $, then the completion may not work correctly
Please raise an issue here if you have any problems.
You can also join our public Slack Channel.
Full Change List
Full Changelog: 1.7.0...1.7.1
Coherence CLI - 1.7.0
Coherence CLI Release 1.7.0
Introduction
This is release 1.7.0 of the Coherence Command Line Interface (CLI).
For more information, see the README.
Installing
See here for installation instructions.
Upgrading
If you already have the CLI installed, you can run cohctl version -u
to see if you have the latest version.
Getting Started
To get started, visit the Coherence CLI documentation and follow the instructions to install and start using the CLI.
New Features / Changes
- Added experimental
cohctl monitor cluster
command to view multiple panels with different information using a text based UI. See the documentation for more information - Added the
-F
option to thestart cluster
orcreate cluster
to specify to only use the specified profile on the first member started - Added the
-B
option to backup the log files when starting a new cluster - Added the ability to specify TLS environment variables to configure TLS connections see the documentation for more information
- Added the
-I
option tocohctl monitor health
to ignore any errors
Dependency Updates
- Added tests to run TLS
- Update privy scan version
Bug Fixes
- N/A
Known Issues
- If you use the new command completion for services or caches that contain a $, then the completion may not work correctly
Please raise an issue here if you have any problems.
You can also join our public Slack Channel.
Full Change List
- Prepare for next release by @tmiddlet2666 in #182
- Remove deprecated set-output command by @tmiddlet2666 in #183
- Add -F option to specify to only use the specified profile on the fir… by @tmiddlet2666 in #184
- Dump logs on container failure startup by @tmiddlet2666 in #187
- Update all tests to dump logs by @tmiddlet2666 in #188
- more log debug by @tmiddlet2666 in #189
- Monitor cluster prototype by @tmiddlet2666 in #186
- Fixup workflow error by @tmiddlet2666 in #190
- Add proxy-connections by @tmiddlet2666 in #191
- Add option to backup coherence logs before startup by @tmiddlet2666 in #192
- Update backlog variable for topics by @tmiddlet2666 in #193
- Add show-panels in help by @tmiddlet2666 in #194
- Minor updates by @tmiddlet2666 in #195
- Optimizations for data retreival and addition of basic expect test by @tmiddlet2666 in #196
- Enable TLS tests by @tmiddlet2666 in #197
- Minor changes to tls messages by @tmiddlet2666 in #198
- Minor update to deps by @tmiddlet2666 in #199
- Add -I option to ignore health errors by @tmiddlet2666 in #200
- Minor update to docs and coherence-go-client version by @tmiddlet2666 in #201
- Update trivy version by @tmiddlet2666 in #202
- Minor health command update by @tmiddlet2666 in #203
- Minor update to monitor health output by @tmiddlet2666 in #204
Full Changelog: 1.6.1...1.7.0
Coherence CLI - 1.6.1
Coherence CLI Release 1.6.1
Introduction
This is release 1.6.1 of the Coherence Command Line Interface (CLI).
For more information, see the README.
Installing
See here for installations instructions.
Upgrading
If you already have the CLI installed, you can run cohctl version -u
to see if you have the latest version.
Getting Started
To get started, visit the Coherence CLI documentation and follow the instructions to install and start using the CLI.
New Features / Changes
- Added
cohctl monitor health
to display health endpoint health status for rolling upgrades - When creating a cluster, save the start class if its changed by the
-S
option - Add Coherence Helidon start class
- Updated to use latest 22.06.8 release as default
Dependency Updates
- Update various GitHub actions
- Update CI/CD versions to include 22.06.8
Bug Fixes
- N/A
All changes since 1.6.0 - 1.6.0...1.6.1
Known Issues
- If you use the new command completion for services or caches that contain a $, then the completion may not work correctly
Please raise an issue here if you have any problems.
You can also join our public Slack Channel.
Coherence CLI - 1.6.0
Introduction
This is release 1.6.0 of the Coherence Command Line Interface (CLI).
For more information, see the README.
Installing
See here for installations instructions.
Upgrading
If you already have the CLI installed, you can run cohctl version -u
to see if you have the latest version.
Getting Started
To get started, visit the Coherence CLI documentation and follow the instructions to install and start using the CLI.
New Features / Changes
- Added
-B
option tocohctl get service-members
to only show members with task backlog > 0 - Added additional color formatting to
cohctl get services
- Added
cohctl get view-caches
andcohctl describe view-caches
commands. Only supported against CE 24.03+, but will be available in future patches for other CE and commercial versions - Added retries to
cohctl describe federation
wide option - only available in the latest Coherence Grid Edition patches - Added
cohctl get cache-partitions
to view cache partition information regarding a cache. Only supported in CE 24.03+, but will be available in future patches for other CE and commercial versions - Added the
-e
option to create , start and scale cluster to set the starting health port - Added the ability to specify a cache config and override file on create cluster
- Added the
-J
option to start a JMX remote management port on the management member
Dependency Updates
- Bump version of jline to 3.25.0
- Bump version of coherence-go-client to v1.1.1
- Bump version of cobra to v1.8.0
Bug Fixes
- Fixed an issue where
cohctl get persistence
may fail if you have a view cache defined
All changes since 1.5.3 - 1.5.3...1.6.0
Known Issues
- If you use the new command completion for services or caches that contain a $, then the completion may not work correctly
Please raise an issue here if you have any problems.
You can also join our public Slack Channel.
Coherence CLI - 1.5.3
Coherence CLI Release 1.5.3
Introduction
This is release 1.5.3 of the Coherence Command Line Interface (CLI).
For more information, see the README.
Installing
See here for installations instructions.
Upgrading
If you already have the CLI installed, you can run cohctl version -u
to see if you have the latest version.
Getting Started
To get started, visit the Coherence CLI documentation and follow the instructions to install and start using the CLI.
New Features / Changes
- Added the
cohctl get cache-storage
command to display cache storage information for a cache - Added the
cohctl get cache-access
command to display cache access information for a cache - Added the
cohctl get cache-indexes
command to display cache index information for a cache - Added the ability to sort the output of
cohctl get p2p-stats
by publisher or receiver rate - Added the ability to disable the CLI under the Coherence Operator if required by setting the env variable
CLI_DISABLED=true
, available in Coherence Operator 3.3.2+
Other Changes
- Updated the dependency on coherence-go-client to v1.0.3
- Updated to build with Go 1.20
All changes since 1.5.2 - 1.5.2...1.5.3
Known Issues
- If you use the new command completion for services or caches that contain a $, then the completion may not work correctly
Please raise an issue here if you have any problems.
You can also join our public Slack Channel.
Coherence CLI - 1.5.2
Coherence CLI Release 1.5.2
Introduction
This is release 1.5.2 of the Coherence Command Line Interface (CLI).
For more information, see the README.
Installing
See here for installations instructions.
Upgrading
If you already have the CLI installed, you can run cohctl version -u
to see if you have the latest version.
Getting Started
To get started, visit the Coherence CLI documentation and follow the instructions to install and start using the CLI.
New Features / Changes
- Added
cohctl get service-distributions
to show scheduled partition distributions - Added
settings
option tostart jfr
command to allow to change the settings file - Added evictions to
cohctl get caches
andcohctl describe caches
commands - Update topics commands to display channel ownership (Thanks to @thegridman)
- Changed the default CE version to 22.06.6 and support CE 23.09
- The following are only available with 23.09, 22.06.6 and the latest commercial patch 14.1.1.2206.6
- Added
cohctl get service-description
to show service description and members - Added
cohctl get member-description
to show member description - Added
cohctl get cluster-description
to show the cluster description and members - Added
cohctl get cluster-config
to display the operational config for a cluster. Only available with most recent versions of Coherence clusters
- Added
Bug Fixes
- Fixed an issue with connecting using VisualVM to a cluster created with the CLI. You must remove an existing cluster and re-create a cluster for this to take effect
- Fixed an issue where describe service would fail with only 1 node
- Bump golang.org/x/net from 0.8.0 to 0.17.0
All changes since 1.5.1 - 1.5.1...1.5.2
Known Issues
- If you use the new command completion for services or caches that contain a $, then the completion may not work correctly
Please raise an issue here if you have any problems.
You can also join our public Slack Channel.
Coherence CLI - 1.5.1
Introduction
This is release 1.5.1 of the Coherence Command Line Interface (CLI).
For more information, see the README.
Installing
See here for installations instructions.
Upgrading
If you already have the CLI installed, you can run cohctl version -u
to see if you have the latest version.
Getting Started
To get started, visit the Coherence CLI documentation and follow the instructions to install and start using the CLI.
New Features / Changes
- Added
cohctl truncate cache
andcohctl clear cache
to truncate and clear a caches contents. Only available with the most recent Coherence versions 14.1.1.2206.5 and 22.06.5 and above - Enhanced command completion for
describe
commands to suggest appropriate values. E.g.cohctl describe cache
- then TAB, TAB shows the list of caches in the cluster. This is also available in various other commands. - Updated
create cluster
to use CE 22.06.5 as default Coherence version - Updated Cobra version to v1.7.0
Bug Fixes
- When removing a cluster, only check for running processes if it was manually created
Known Issues
- If you use the new command completion for services or caches that contain a $, then the completion may not work correctly
Please raise an issue here if you have any problems.
You can also join our public Slack Channel.
Coherence CLI - 1.5.0
Introduction
This is release 1.5.0 of the Coherence Command Line Interface (CLI).
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.
For more information, see the README.
Installing
See here for installations instructions.
Upgrading
If you already have the CLI installed, you can run cohctl version -u
to see if you have the latest version.
Getting Started
To get started, visit the Coherence CLI documentation and follow the instructions to install and start using the CLI.
New Features / Changes
- Added support for Coherence CE versions 23.03, 22.06.4 plus commercial versions 14.1.1.2206.4
- Topics
- Added commands to display topics, subscribers and subscriber groups. See here for more information
- Members
- Added
cohctl get network-stats
to show all member network statistic for a cluster - Added
cohctl get p2p-stats
to show point-to-point network statistics for a specific member - Added the
-S
option toget members
to show a summary of members
- Added
- Services/ Caches
- Added
cohctl get service-storage
to show partition storage for all services - Added
cohctl get cache-stores
to show cache store information for a cache - When you describe a cache or topic you no longer need to specify the service if the cache is unique
- Added
- Proxy Servers
- Added
cohctl reset proxy-stats
to reset connection manager stats. Only available with recent CE releases
- Added
- Federation
- Added
cohctl set federation
to set traceLogging for a federated service - (federation is only available in Grid Edition)
- Added
- General
- Added the
-W
watch command to watch and clear screen for a better monitoring experience - Added
cohctl set/get color
to enable/display color formatting of important values. Default is on - Added
cohctl get config
to show config stored in the '.cohctl.yaml' config file in a human readable format - Added the ability to show sizes in terabytes via
--tb
option
- Added the
- Creating Clusters
- Changed the skip-deps short option
-K
oncreate cluster
to -I - Changed the wka short option
-W
oncreate cluster
to-K
- Added the
-L
option tocreate cluster
to specify an alternate log location
- Changed the skip-deps short option
- Infrastructure
- Update to compile using Go 1.19.6
Bug Fixes
- Fixed an issue where a nil pointer panic would occur when the users $HOME directory was not writable
- Renamed columns on
get proxy-connections
to better reflect the data - Fixed an issue where
describe cache
would not show the key and filter listeners
Problems/ Questions
Please raise an issue here if you have any problems.
You can also join our public Slack Channel.