Skip to content

Commit

Permalink
add See Also section
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewazores committed May 27, 2024
1 parent 8e58333 commit c5ee622
Showing 1 changed file with 32 additions and 4 deletions.
36 changes: 32 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,39 @@
[![CI build and push](https://github.com/cryostatio/cryostat3/actions/workflows/push-ci.yaml/badge.svg)](https://github.com/cryostatio/cryostat3/actions/workflows/push-ci.yaml)
[![Google Group : Cryostat Development](https://img.shields.io/badge/Google%20Group-Cryostat%20Development-blue.svg)](https://groups.google.com/g/cryostat-development)

## USING
A container-native JVM application which acts as a bridge to other containerized JVMs and exposes a secure API for producing, analyzing, and retrieving JDK Flight Recorder data from your cloud workloads.

Most users will be best served starting at [`cryostat.io`](https://cryostat.io), the documentation website for Cryostat.
Here you will find instructions on how to install Cryostat using the [Cryostat Operator](https://github.com/cryostatio/cryostat-operator),
how to configure your applications to enable connectivity, and how to use the Cryostat application.
## SEE ALSO

* [cryostat.io](https://cryostat.io) : upstream documentation website with user
guides, tutorials, blog posts, and other user-facing content. Start here if
what you've read so far sounds interesting and you want to know more as a
**user**, rather than as a _developer_. Here you will find instructions on
how to install Cryostat using the
[Cryostat Operator](https://github.com/cryostatio/cryostat-operator), how to
configure your applications to enable connectivity, and how to use the
Cryostat application.

* [cryostat-core](https://github.com/cryostatio/cryostat-core) : the core library
providing a convenience wrapper and headless stubs for use of JFR using
JDK Mission Control internals.

* [cryostat-operator](https://github.com/cryostatio/cryostat-operator) : an Operator
for deploying Cryostat in your OpenShift or Kubernetes cluster.

* [cryostat-helm](https://github.com/cryostatio/cryostat-helm): a Helm Chart for
deploying Cryostat in your OpenShift or Kubernetes cluster

* [cryostat-web](https://github.com/cryostatio/cryostat-web) : the React frontend
included as a submodule in Cryostat and built into Cryostat's OCI images.

* [JDK Mission Control](https://github.com/openjdk/jmc) : the desktop application
complement to JFR. Some parts of JMC are borrowed and re-used to form the basis of
Cryostat. JMC is still a recommended tool for more full-featured analysis of JFR
files beyond what Cryostat currently implements.

* [binjr](https://github.com/binjr/binjr) : a timeseries visualization desktop
application which supports reading JFR files

This repository contains the source code for Cryostat versions 3.0 and later. Cryostat (née "container-jfr") versions prior to 3.0
are located at [cryostatio/cryostat](https://github.com/cryostatio/cryostat). Container images from both are published to the same
Expand Down

0 comments on commit c5ee622

Please sign in to comment.