From 03e746eef5bba8c15e91ed7d5c2dd96b4a02e68e Mon Sep 17 00:00:00 2001 From: Andrew Azores Date: Mon, 27 May 2024 13:36:50 -0400 Subject: [PATCH 1/5] add project logo --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 7d7136a6c..f6a1ec818 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # Cryostat + + + + + + + [![CI build and push](https://github.com/cryostatio/cryostat3/actions/workflows/push-ci.yaml/badge.svg "Continuous Integration")](https://github.com/cryostatio/cryostat3/actions/workflows/push-ci.yaml) [![Quay Repository](https://img.shields.io/badge/Container_Image-cryostat/cryostat-teal.svg "Quay Repository")](https://quay.io/repository/cryostat/cryostat) [![Google Group : Cryostat Development](https://img.shields.io/badge/Google_Group-Cryostat_Development-blue.svg "Mailing List")](https://groups.google.com/g/cryostat-development) From 7043ea663a293dc8a9378c9b54ae2f0db189bf54 Mon Sep 17 00:00:00 2001 From: Andrew Azores Date: Mon, 27 May 2024 13:51:49 -0400 Subject: [PATCH 2/5] add See Also section --- README.md | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f6a1ec818..9e62813d6 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,39 @@ [![Quay Repository](https://img.shields.io/badge/Container_Image-cryostat/cryostat-teal.svg "Quay Repository")](https://quay.io/repository/cryostat/cryostat) [![Google Group : Cryostat Development](https://img.shields.io/badge/Google_Group-Cryostat_Development-blue.svg "Mailing List")](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 From 92be6adddfe2dd14a11e8dd0934267ef1101f2ba Mon Sep 17 00:00:00 2001 From: Andrew Azores Date: Mon, 27 May 2024 13:52:03 -0400 Subject: [PATCH 3/5] update 'requirements' section --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9e62813d6..d2e8378be 100644 --- a/README.md +++ b/README.md @@ -57,19 +57,24 @@ We welcome and appreciate any contributions from our community. Please visit our ## REQUIREMENTS -Build Requirements: -- Git -- JDK v17+ +Build requirements: +- git +- JDK 17+ - Maven v3+ - [Quarkus CLI](https://quarkus.io/guides/cli-tooling) v3.4.1+ (Recommended) - [Podman](https://podman.io/docs/installation) 4.7+ -Run Requirements: +Smoketest run requirements: - [`yq`](https://github.com/mikefarah/yq) v4.35.1+ - [`kompose`](https://kompose.io/installation/) v1.31.2+ - [docker-compose](https://docs.docker.com/compose/install/) v1.29.2 - [podman-docker](https://packages.fedoraproject.org/pkgs/podman/podman-docker/) (Optional) +General run requirements: +- an OpenShift or Kubernetes cluster + - recommended installation methods: [`cryostat-operator`](https://github.com/cryostatio/cryostat-operator) or [`cryostat-helm`](https://github.com/cryostatio/cryostat-helm) +- OR any other container platform which can host OCI containers + ## BUILD This project uses Quarkus, the Supersonic Subatomic Java Framework. From 75724c975f6494901904d8d55d91a73c4a6e2b67 Mon Sep 17 00:00:00 2001 From: Andrew Azores Date: Mon, 27 May 2024 13:54:39 -0400 Subject: [PATCH 4/5] remove heading --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index d2e8378be..da58119a7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -# Cryostat - From e877abb63c2e34e4905b87a3b0fc1bd010e8b552 Mon Sep 17 00:00:00 2001 From: Andrew Azores Date: Mon, 27 May 2024 14:29:02 -0400 Subject: [PATCH 5/5] add logo images --- docs/images/cryostat_icon_rgb_default.svg | 1 + docs/images/cryostat_icon_rgb_reverse.svg | 1 + docs/images/cryostat_logo_hori_rgb_default.svg | 1 + docs/images/cryostat_logo_hori_rgb_reverse.svg | 1 + docs/images/cryostat_logo_vert_rgb_default.svg | 1 + docs/images/cryostat_logo_vert_rgb_reverse.svg | 1 + 6 files changed, 6 insertions(+) create mode 100644 docs/images/cryostat_icon_rgb_default.svg create mode 100644 docs/images/cryostat_icon_rgb_reverse.svg create mode 100644 docs/images/cryostat_logo_hori_rgb_default.svg create mode 100644 docs/images/cryostat_logo_hori_rgb_reverse.svg create mode 100644 docs/images/cryostat_logo_vert_rgb_default.svg create mode 100644 docs/images/cryostat_logo_vert_rgb_reverse.svg diff --git a/docs/images/cryostat_icon_rgb_default.svg b/docs/images/cryostat_icon_rgb_default.svg new file mode 100644 index 000000000..9509dfc42 --- /dev/null +++ b/docs/images/cryostat_icon_rgb_default.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/images/cryostat_icon_rgb_reverse.svg b/docs/images/cryostat_icon_rgb_reverse.svg new file mode 100644 index 000000000..0f05fa189 --- /dev/null +++ b/docs/images/cryostat_icon_rgb_reverse.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/images/cryostat_logo_hori_rgb_default.svg b/docs/images/cryostat_logo_hori_rgb_default.svg new file mode 100644 index 000000000..76c9b2d02 --- /dev/null +++ b/docs/images/cryostat_logo_hori_rgb_default.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/images/cryostat_logo_hori_rgb_reverse.svg b/docs/images/cryostat_logo_hori_rgb_reverse.svg new file mode 100644 index 000000000..90b38d973 --- /dev/null +++ b/docs/images/cryostat_logo_hori_rgb_reverse.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/images/cryostat_logo_vert_rgb_default.svg b/docs/images/cryostat_logo_vert_rgb_default.svg new file mode 100644 index 000000000..c9588621a --- /dev/null +++ b/docs/images/cryostat_logo_vert_rgb_default.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/images/cryostat_logo_vert_rgb_reverse.svg b/docs/images/cryostat_logo_vert_rgb_reverse.svg new file mode 100644 index 000000000..5062b5e36 --- /dev/null +++ b/docs/images/cryostat_logo_vert_rgb_reverse.svg @@ -0,0 +1 @@ + \ No newline at end of file