docs(get-started): add information about the Agent and JMX config #104

andrewazores · 2023-04-26T16:52:34Z

Related to #102
Fixes #93
Fixes #92
Fixes #91
Fixes #58

guides/_subsections/using-the-cryostat-agent.md

get-started/index.md

tthvo

Looks good to me :D

…yostatio#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

….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>

andrewazores mentioned this pull request Apr 26, 2023

feat(version): copy guides to 2.2.0 version and create new latest/2.3.0 version #103

Merged

3 tasks

andrewazores added docs Improvements or additions to documentation feat New feature or request labels Apr 26, 2023

andrewazores requested review from ebaron, tthvo, maxcao13 and cmah88 April 26, 2023 16:53

maxcao13 reviewed Apr 26, 2023

View reviewed changes

guides/_subsections/using-the-cryostat-agent.md Outdated Show resolved Hide resolved