feat(version): copy guides to 2.2.0 version and create new latest/2.3…

….0 version (#103) * feat(version): copy guides to 2.2.0 version and create new latest/2.3.0 version * docs(agent): create initial content for Cryostat Agent (#101) * Create document-agent's-general-description+purpose.md Documented the Agent's general description + purpose Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> * Update document-agent's-general-description+purpose.md Effected the corrections. Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> * minor fixes * move content into guide --------- Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> Co-authored-by: Andrew Azores <aazores@redhat.com> * docs(screenshots): update screenshots for 2.3.0 (#105) * update screenshots, fix some anchors * correct filenames * remove unnecessary paragraph tags * pluralize * clarify * simplify * singularize * fixup! singularize * fixup! fixup! singularize * chore(versions): bump supported platform versions (#111) * feat(demo): embed web-client with fake API stubs as a demo (#109) * docs(getting-started): update sample app example (#115) * docs(auth): remove outdated Bearer form, add details on OpenShift and Basic mechanisms (#113) * doc(auth): remove outdated Bearer form, add details on OpenShift and Basic mechanisms Signed-off-by: Andrew Azores <aazores@redhat.com> * reflow * formatting * backtick quotes --------- Signed-off-by: Andrew Azores <aazores@redhat.com> * feat(cred): document credentials testing table (#119) * docs(get-started): add information about the Agent and JMX config (#104) * docs(get-started): add information about the Agent and JMX config * typo * rephrase * quotes and typo * add anchors * openshift -> kubernetes * add note about maven registry auth * add comments * accept suggestion * typo * formatting * typo * formatting * break comment lines * use yaml multiline * plural * rephrase * add explanation comment * fixup! add explanation comment * rebase fix * list configuration combinations before explaining them * add links * rephrase * fix typo * fixup! fix typo * explain agent deployment environment variables more * explain cross-namespace Agent and Cryostat * reference agent version 0.2.1 * in hybrid agent setup, skip the jfr-jmx named port * set explicit hostname for JMX * reorganize * feat(topology): document topology view and custom target form (#118) * chore(rules): update docs to mention Match Expression Visualizer * feat(topology): add docs for creating a custom target * feat(topology): document topology usage Signed-off-by: Thuan Vo <thvo@redhat.com> --------- Signed-off-by: Thuan Vo <thvo@redhat.com> * chore(docs): update (un)installation info, images, and document ClusterCryostat (#117) * docs(install): update installation information and images * update operator-sdk version * add table of contents * update step reference and links * add documentation about ClusterCryostat * split text into list * use usual default CR YAML for example * specify example's installation mode * distinguish OpenShift Console Topology View * cleanup outdated info * fixup! cleanup outdated info * correct screenshot * explain why CRs are namespace-specific * commas * remove outdated alternate operator installation methods * remove unused uninstallation steps * inline doc * point GitHub docs links to release branches, not latest development * add detail * comma * clarify one instance of Kubernetes-specific requirement * update olm instructions * syntax highlighting hints * docs(dashboard): document dashboard and dashboard cards (#121) * init commit Signed-off-by: Max Cao <macao@redhat.com> * add mbean metrics, layouts/templates Signed-off-by: Max Cao <macao@redhat.com> * fix widescreen -> fullscreen Signed-off-by: Max Cao <macao@redhat.com> --------- Signed-off-by: Max Cao <macao@redhat.com> * feat(blog): add 2.3.0 release post (#124) * chore(gem): add table-of-contents plugin * chore(blog): enable toc plugin on existing blog posts * feat(blog): add 2.3.0 release announcement post * link helm to specific release * add note about OLM * add link * comma * comma * set blog date --------- Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> Signed-off-by: Andrew Azores <aazores@redhat.com> Signed-off-by: Thuan Vo <thvo@redhat.com> Signed-off-by: Max Cao <macao@redhat.com> Co-authored-by: Esther Christopher <estheradamuchris@gmail.com> Co-authored-by: Thuan Vo <thvo@redhat.com> Co-authored-by: Max Cao <macao@redhat.com>
cryostatio · May 25, 2023 · 85be994 · 85be994
1 parent 7a89513
commit 85be994
Show file tree

Hide file tree

Showing 399 changed files with 4,473 additions and 281 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,8 @@ _site
 .jekyll-metadata
 vendor
 **/.DS_Store
+
+demo/node_modules/
+demo/.yarn/
+demo/.yarnrc.yml
+demo/.pnp.cjs
diff --git a/Gemfile b/Gemfile
@@ -18,6 +18,7 @@ gem "minima", "~> 2.5"
 group :jekyll_plugins do
   gem "jekyll-feed", "~> 0.17"
   gem "jekyll-paginate"
+  gem "jekyll-toc"
 end
 
 # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -39,6 +39,9 @@ GEM
       sass-embedded (~> 1.54)
     jekyll-seo-tag (2.7.1)
       jekyll (>= 3.8, < 5.0)
+    jekyll-toc (0.18.0)
+      jekyll (>= 3.9)
+      nokogiri (~> 1.12)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     kramdown (2.4.0)
@@ -50,13 +53,20 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.4.0)
+    mini_portile2 (2.8.2)
     minima (2.5.1)
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
+    nokogiri (1.15.2)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.15.2-x86_64-linux)
+      racc (~> 1.4)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (5.0.1)
+    racc (1.6.2)
     rake (13.0.6)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
@@ -82,6 +92,7 @@ DEPENDENCIES
   jekyll (~> 4.3.0)
   jekyll-feed (~> 0.17)
   jekyll-paginate
+  jekyll-toc
   minima (~> 2.5)
   tzinfo (~> 1.2)
   tzinfo-data

diff --git a/README.md b/README.md
@@ -30,3 +30,9 @@ to install project dependencies.
 - `bundle exec jekyll serve --watch --livereload --open-url --future --config _config.yml,_config-dev.yml`
 
 This will start a local development server, open your default browser pointing to the local build on that server, with the server watching for project filesystem changes and hot-reloading the browser when changes are detected and rebuilt.
+
+### Updating Demo
+
+```bash
+$ bash build-demo.bash cryostat-v2.3
+```
diff --git a/_config.yml b/_config.yml
@@ -35,6 +35,7 @@ theme: minima
 plugins:
   - jekyll-feed
   - jekyll-paginate
+  - jekyll-toc
 
 sass:
   style: compressed

diff --git a/_data/versions.yaml b/_data/versions.yaml
@@ -1,7 +1,17 @@
 cryostat:
-  version: 2.2.0
+  version: 2.3.0
+  release-branch: cryostat-v2.3
+openshift:
+  version: '4.10'
+kubernetes:
+  version: '1.19'
+operator-sdk:
+  version: '1.28.0'
+operator-lifecycle-manager:
+  version: '0.24.0'
 documentation:
   - 'latest'
+  - 2.2.0
   - 2.1.0
   - 2.0.0
   - 1.0.0
diff --git a/_includes/header.html b/_includes/header.html
@@ -21,6 +21,7 @@
           <div class="trigger">
               <a class="page-link" href="/get-started/">Get Started</a>
               <a class="page-link" href="/guides/">Guides</a>
+              <a class="page-link" href="/demo/">Demo</a>
               <a class="page-link" href="/blog/">Blog</a>
           </div>
         </nav>

diff --git a/_layouts/demo.html b/_layouts/demo.html
@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: "en" }}">
+
+  {%- include head.html -%}
+
+  <body>
+
+    {%- include header.html -%}
+
+    <main class="page-content" aria-label="Content">
+      {{ content }}
+    </main>
+
+    {%- include footer.html -%}
+    {%- include redhat-footer.html -%}
+    {%- include scripts.html -%}
+    {%- include rh-analytics-footer.html -%}
+  </body>
+
+</html>
diff --git a/_layouts/get-started.html b/_layouts/get-started.html
@@ -0,0 +1,64 @@
+---
+layout: default
+---
+
+{% include back-to-top.html %}
+
+<div class="home">
+
+  {%- if page.title -%}
+    <h1 class="page-heading">{{ page.title }}</h1>
+  {%- endif -%}
+
+  {{ content }}
+
+
+  {% if site.paginate %}
+    {% assign posts = paginator.posts %}
+  {% else %}
+    {% assign posts = site.posts %}
+  {% endif %}
+
+
+  {%- if posts.size > 0 -%}
+    {%- if page.list_title -%}
+      <h2 class="post-list-heading">{{ page.list_title }}</h2>
+    {%- endif -%}
+    <ul class="post-list">
+      {%- assign date_format = site.minima.date_format | default: "%b %-d, %Y" -%}
+      {%- for post in posts -%}
+      <li>
+        <span class="post-meta">{{ post.date | date: date_format }}</span>
+        <h3>
+          <a class="post-link" href="{{ post.url | relative_url }}">
+            {{ post.title | escape }}
+          </a>
+        </h3>
+        {%- if site.show_excerpts -%}
+          {{ post.excerpt }}
+        {%- endif -%}
+      </li>
+      {%- endfor -%}
+    </ul>
+
+    {% if site.paginate %}
+      <div class="pager">
+        <ul class="pagination">
+        {%- if paginator.previous_page %}
+          <li><a href="{{ paginator.previous_page_path | relative_url }}" class="previous-page">{{ paginator.previous_page }}</a></li>
+        {%- else %}
+          <li><div class="pager-edge">•</div></li>
+        {%- endif %}
+          <li><div class="current-page">{{ paginator.page }}</div></li>
+        {%- if paginator.next_page %}
+          <li><a href="{{ paginator.next_page_path | relative_url }}" class="next-page">{{ paginator.next_page }}</a></li>
+        {%- else %}
+          <li><div class="pager-edge">•</div></li>
+        {%- endif %}
+        </ul>
+      </div>
+    {%- endif %}
+
+  {%- endif -%}
+
+</div>
diff --git a/_layouts/home.html b/_layouts/home.html
@@ -16,7 +16,9 @@
                         Securely manage JFR recordings for your containerized Java workloads. Start, stop, and dump recordings for further analysis with triggers on Kubernetes
                     </div>
                     <div style="margin-top: 2em">
-                      Cryostat is an upstream project sponsored by Red Hat and is available for Kubernetes 1.19+ and OpenShift 4.6+
+                      Cryostat is an upstream project sponsored by Red Hat and is available for
+                      Kubernetes {{ site.data.versions.kubernetes.version }}+
+                      and OpenShift {{ site.data.versions.openshift.version }}+
                     </div>
                 </div>
             </div>

diff --git a/_layouts/post.html b/_layouts/post.html
@@ -12,6 +12,7 @@
 
   <h1>{{ page.title }}</h1>
 
+  <hr>
   <div class="byline-wrapper">
     {% assign author = site.data.authors[page.author] %}
     {% if author.emailhash %}
@@ -24,6 +25,12 @@ <h1>{{ page.title }}</h1>
     {% endif %}
   </div>
 
+  <div>
+  Table of Contents:
+  </div>
+  {% toc %}
+  <hr>
+
   {{ content }}
 
 </div>

diff --git a/_posts/2022-09-30-cryosat-blog.md b/_posts/2022-09-30-cryosat-blog.md
@@ -4,7 +4,7 @@ title: 'Hello World'
 date: 2022-09-30
 synopsis: Introducing Cryostat's Upstream Blog
 author: Andrew Azores
-
+toc: true
 ---
 
 Hello, readers!

diff --git a/_posts/2022-10-18-archive-on-stop.md b/_posts/2022-10-18-archive-on-stop.md
@@ -4,7 +4,7 @@ title: '"Archive On Stop" feature in the Cryostat 2.2'
 date: 2022-10-18
 synopsis: Cryostat 2.2 New features
 author: Leticia Konno
-
+toc: true
 ---
 
 Hello, readers!

diff --git a/_posts/2022-11-15-cryostat-release.md b/_posts/2022-11-15-cryostat-release.md
@@ -4,7 +4,7 @@ title: Cryostat 2.2.0 is Released!
 date: 2022-11-15
 synopsis: Cryostat 2.2.0 is here. Learn what's new in this release.
 author: Andrew Azores
-
+toc: true
 ---
 
 Hello readers, and welcome back to the Cryostat blog. Today we have exciting news: Cryostat 2.2.0 is released!

diff --git a/_posts/2023-05-03-agent-threads-investigation.md b/_posts/2023-05-03-agent-threads-investigation.md
@@ -4,6 +4,7 @@ title: 'An Introspective Investigation'
 date: 2023-05-03
 synopsis: Investigating a bug in the new Cryostat Agent, using Cryostat.
 author: Andrew Azores
+toc: true
 ---
 
 *Preface: this blog post is about the new [Cryostat Agent](https://github.com/cryostatio/cryostat-agent),

diff --git a/_posts/2023-05-26-cryostat-release.md b/_posts/2023-05-26-cryostat-release.md
@@ -0,0 +1,53 @@
+---
+layout: post
+title: Cryostat 2.3.0 is Released!
+date: 2023-05-26
+synopsis: Cryostat 2.3.0 is here. Learn what's new in this release.
+author: Andrew Azores
+toc: true
+---
+
+Hello everyone,
+
+We are pleased to announce the release of Cryostat 2.3!
+
+## [What’s New in 2.3?](#whats-new-in-23)
+- **[Cryostat Agent](/guides#using-the-cryostat-agent)**: an agent can be included in your deployment, which
+    facilitates application discovery and JFR operations over HTTP API
+- **[Cross-namespace target discovery](/get-started/#using-clustercryostats)**: a `ClusterCryostat` custom resource can
+    be configured to communicate with applications deployed across multiple namespaces
+- **Web interface enhancements**:
+  - **Quick starts and Guided Tour**: short tutorials on how to navigate and perform basic functions in Cryostat
+  - **[Topology view with bulk actions](/guides#use-topology-view)**: view your deployed applications in a topology
+  view and create JFR recordings in bulk
+  - **[Customizable dashboards](/guides#navigate-the-dashboard)**: view and configure cards displaying your JVM metrics on a dashboard
+- **Podman API**: Discover target applications using Podman HTTP API. This requires the Podman service to be running.
+    You might try `systemctl --user enable --now podman.socket`. The next time you run Cryostat under your user, it will
+    be able to talk to Podman and query for running containers with the label `io.cryostat.connectUrl`. The value of
+    this label is expected to be a JMX service URL for the JVM within the container.
+
+## What’s Next?
+- Additional types of analyses and visualizations
+- Smart triggering of JFR start/stop based on JVM conditions
+
+## Where can I get the latest version of Cryostat?
+You can install Cryostat using our
+[Kubernetes operator on OperatorHub.io](https://operatorhub.io/operator/cryostat-operator)
+or via a
+[Helm Chart](https://github.com/cryostatio/cryostat-helm/releases/tag/v0.3.0)
+. As always, you can also run Cryostat in other environments with a little more manual setup.
+
+If this is your first time installing Cryostat on Kubernetes, you can [Get Started](/get-started) right here on this
+website.
+
+If you had previously installed Cryostat Operator 2.2.0 with OLM, then you may have already been upgraded to 2.3.0, or
+else you should be able to approve and install the upgrade.
+
+## Blogs
+This is a really big release with many new features, including several that have been long requested by the community.
+Watch this space for more posts about some of the ["What's New"](#whats-new-in-23) items above.
+
+## Feedback
+Our team is very excited to present this update to Cryostat and we look forward to your feedback. Please reach out to
+the [Cryostat mailing list](mailto:cryostat-development@googlegroups.com) or
+[GitHub Discussion](https://github.com/cryostatio/cryostat/discussions/1493) with any questions or comments.
diff --git a/_sass/core/cryostat.scss b/_sass/core/cryostat.scss
@@ -140,6 +140,26 @@ details > figure > a > img {
   border: 2px solid $grey-0;
 }
 
+details p {
+  font-family: inherit;
+  font-weight: inherit;
+}
+
+details {
+  .multi-image {
+    display: flex;
+    figure {
+      figcaption {
+        text-align: center;
+      }
+    }
+  }
+}
+
+figcaption > code {
+  font-size: 0.9em;
+}
+
 .page-link {
   font-size: 1.25em;
 }

diff --git a/_sass/core/demo.scss b/_sass/core/demo.scss
@@ -0,0 +1,23 @@
+.linear-dot-spinner {
+  width: 2em;
+  aspect-ratio: 4;
+  background: radial-gradient(circle closest-side, #73BCF7 90%, #0000) 0/calc(100%/3) 100% space;
+  clip-path: inset(0 100% 0 0);
+  animation: linear-dot-spinner-animate 1s steps(4) infinite;
+}
+
+@keyframes linear-dot-spinner-animate {
+  to {
+    clip-path: inset(0 -34% 0 0)
+  }
+}
+
+.demo-iframe {
+  opacity: 0;
+  box-sizing: border-box;
+  width: 100%;
+  height: 50em;
+  scale: 0.98;
+  border: 1px solid;
+  border-radius: 4px;
+}
diff --git a/_sass/includes/header.scss b/_sass/includes/header.scss
@@ -32,4 +32,4 @@
     } 
     }
   }
-}
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -32,4 +32,4 @@ @@
         }
         }
       }
-    }
+    }