Skip to content

Commit

Permalink
updated links from MD files to HC (#674)
Browse files Browse the repository at this point in the history
* updated links from MD files to HC

* Updated links to documentation in Welcome Dashboard

---------

Co-authored-by: gsmith-sas <[email protected]>
  • Loading branch information
technomerlyn and gsmith-sas authored Sep 12, 2024
1 parent fca3423 commit e0dddc9
Show file tree
Hide file tree
Showing 23 changed files with 52 additions and 65 deletions.
2 changes: 1 addition & 1 deletion Cloud_Providers.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Cloud Providers

See [Monitoring and Logging on Cloud-Provider Platforms](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n0lzjee544jib9n1dj4wc0fhuc36.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
See [Monitoring and Logging on Cloud-Provider Platforms](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=n0lzjee544jib9n1dj4wc0fhuc36.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ Log monitoring and metric monitoring can be deployed independently or together.

For information about SAS® Viya® Monitoring for Kubernetes, see the following sections in the SAS Viya Monitoring for Kubernetes Help Center:

- For an introduction, see [About SAS® Viya® Monitoring for Kubernetes](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n0bzfdp3bn6p4vn1lj9pm2hy8t0q.htm).
- For an introduction, see [About SAS® Viya® Monitoring for Kubernetes](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=n0bzfdp3bn6p4vn1lj9pm2hy8t0q.htm).

- For information about the application components deployed by SAS® Viya® Monitoring for Kubernetes, the prerequisites, and more, see [Getting Started](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n18d875xbudfken18v75gj7mopxq.htm).

- For information about pre-deployment and customization, see [Pre-deployment](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n1ajbblsxpcgl5n11t13wgtd4d7c.htm).

- For information about deployment, see [Deploy](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n1rhzwx0mcnnnun17q11v85bspyk.htm).
- For information about the components in SAS® Viya® Monitoring for Kubernetes, the prerequisites, and more, see [Getting Started](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=n18d875xbudfken18v75gj7mopxq.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
2 changes: 1 addition & 1 deletion logging/Differences_between_ODFE_and_OpenSearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ When this option is set, OpenSearch Dashboards is accessible on the same port (3

**Note:** As of release 1.2.1, if you do not set the environment variable `KB_KNOWN_NODEPORT_ENABLE` to `true` before running the `logging/bin/deploy_logging.sh` script, you can now use the `configure_nodeport.sh`
script after deployment.
See [Configure Access to OpenSearch](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n0l4k3bz39cw2dn131zcbat7m4r1.htm).
See [Configure Access to OpenSearch](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=n0l4k3bz39cw2dn131zcbat7m4r1.htm).

### Migrate an Existing Deployment

Expand Down
2 changes: 1 addition & 1 deletion logging/Export_Logs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Export Logs

See [How To Export Logs (getlogs.py)](https://documentation.sas.com/?docsetId=obsrvdply&docsetVersion=latest&docsetTarget=p1wdkgnu7dp791n1h9xfyh68ltnt.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
See [Exporting Logs with getlogs.py](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvug&docsetTarget=p1wdkgnu7dp791n1h9xfyh68ltnt.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
2 changes: 1 addition & 1 deletion logging/Limiting_Access_to_Logs.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See [Controlling User Access to Log Monitoring](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=p1nee94eh0x1ymn1blz03g48jz2y.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
See [Control User Access to Log Monitoring](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=p1nee94eh0x1ymn1blz03g48jz2y.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
2 changes: 1 addition & 1 deletion logging/Log_Retention.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See [Adjust the Retention Period for Log Messages](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n1dwvmcsjvmw61n0zyiasrfae2yh.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
See [Adjust the Retention Period for Log Messages](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=n1dwvmcsjvmw61n0zyiasrfae2yh.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
2 changes: 1 addition & 1 deletion logging/Logging_Security.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See [Controlling User Access to Log Monitoring](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=p1nee94eh0x1ymn1blz03g48jz2y.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
See [Control User Access to Log Monitoring](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=p1nee94eh0x1ymn1blz03g48jz2y.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
2 changes: 1 addition & 1 deletion logging/Notes_on_using_TLS.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See [Understanding How Transport Layer Security (TLS) Is Used by SAS Viya Monitoring for Kubernetes](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=p0ssqw32dy9a44n1rokwojskla19.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
See [Transport Layer Security (TLS): Digital Certificates and Kubernetes Secrets](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=p1tedn8lzgvhlyn1bzwgvqvv3p4j.htm#n1pnll5qjcigjvn15shfdhdhr0lz) in the SAS Viya Monitoring for Kubernetes Help Center.
2 changes: 1 addition & 1 deletion logging/OpenShift.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# SAS Viya Log-monitoring on Red Hat OpenShift

See [Monitoring on Red Hat OpenShift](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n1o8xyp2vatupan1nhgknbzhp7tm.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
See [Red Hat OpenShift Considerations](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=n1rn2homfb6tken17qkyrrx9bk8w.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
7 changes: 1 addition & 6 deletions logging/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
# Logging

See the following topics in the SAS Viya Monitoring for Kubernetes Help Center:

* [Getting Started](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n18d875xbudfken18v75gj7mopxq.htm)
* [Pre-deployment](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n1ajbblsxpcgl5n11t13wgtd4d7c.htm)
* [Deploy](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n1rhzwx0mcnnnun17q11v85bspyk.htm)
* [Modify the Deployment](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n08465wdbmux9cn1iz6dk2bzdcw4.htm)
To learn how to deploy the logging component, see [Getting Started](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=n18d875xbudfken18v75gj7mopxq.htm) in the SAS Viya Monitoring for Kubernetes Help Center.

## Important Information about OpenSearch and OpenSearch Dashboards

Expand Down
2 changes: 1 addition & 1 deletion logging/Tenant_Logging.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Implementing Access Limitations for Logging for Tenants

See [Limit Access in a Multi-Tenant Environment](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n12rumatqso1ivn1v4qg4932ajn2.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
See [Limit Access in a Multi-Tenant Environment](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=n12rumatqso1ivn1v4qg4932ajn2.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
2 changes: 1 addition & 1 deletion logging/Troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Troubleshooting

See [Troubleshooting](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=p1f3c5so49c0fyn1hrdplosqc6l1.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
See [Troubleshooting](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=p1f3c5so49c0fyn1hrdplosqc6l1.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
2 changes: 1 addition & 1 deletion monitoring/OpenShift.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Red Hat OpenShift

See [Monitoring on Red Hat OpenShift](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n1o8xyp2vatupan1nhgknbzhp7tm.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
See [Red Hat OpenShift Considerations](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=n1rn2homfb6tken17qkyrrx9bk8w.htm) in the SAS Viya Monitoring for Kubernetes Help Center.

## Azure Red Hat OpenShift (EXPERIMENTAL)

Expand Down
7 changes: 1 addition & 6 deletions monitoring/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# Monitoring

See the following topics in the SAS Viya Monitoring for Kubernetes Help Center:

* [Getting Started](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n18d875xbudfken18v75gj7mopxq.htm)
* [Pre-deployment](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n1ajbblsxpcgl5n11t13wgtd4d7c.htm)
* [Deploy](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n1rhzwx0mcnnnun17q11v85bspyk.htm)
* [Modify the Deployment](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n08465wdbmux9cn1iz6dk2bzdcw4.htm)
To learn how to deploy the monitoring component, see [Getting Started](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=n18d875xbudfken18v75gj7mopxq.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
2 changes: 1 addition & 1 deletion monitoring/Troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Troubleshooting

See [Troubleshooting](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=p1f3c5so49c0fyn1hrdplosqc6l1.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
See [Troubleshooting](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=p1f3c5so49c0fyn1hrdplosqc6l1.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
40 changes: 21 additions & 19 deletions monitoring/dashboards/welcome/viya-welcome-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"content": "![](https://www.sas.com/en_us/navigation/header/global-links-header/_jcr_content/par/styledcontainer_3b8d/par/image_baf8.img.png/1593461099449.png)\n",
"mode": "markdown"
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -82,7 +82,7 @@
"content": "<h1>Welcome to SAS<sup>®</sup> Viya<sup>®</sup> Monitoring for Kubernetes</h1>\n",
"mode": "html"
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -115,7 +115,7 @@
"content": "![](https://raw.githubusercontent.com/sassoftware/viya4-monitoring-kubernetes/master/img/sasViyaLogo_classicBlue.png)\n",
"mode": "markdown"
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -148,7 +148,7 @@
"content": "## SAS Viya Dashboards for Administrators\n\nMonitor the performance of SAS Viya components:",
"mode": "markdown"
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -181,7 +181,7 @@
"content": "![](https://miro.medium.com/max/921/1*7puR5_CHvGxJmnepMfUwYg.png)\n",
"mode": "markdown"
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -214,7 +214,7 @@
"content": "## Kubernetes Dashboards for Administrators\nMonitor the performance of clusters and namespaces:",
"mode": "markdown"
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -245,6 +245,7 @@
"keepTime": false,
"maxItems": 4,
"query": "",
"showFolderNames": true,
"showHeadings": false,
"showRecentlyViewed": false,
"showSearch": true,
Expand All @@ -253,7 +254,7 @@
"welcome-viya"
]
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"query": "",
"recent": false,
"search": true,
Expand Down Expand Up @@ -291,6 +292,7 @@
"keepTime": false,
"maxItems": 4,
"query": "",
"showFolderNames": true,
"showHeadings": false,
"showRecentlyViewed": false,
"showSearch": true,
Expand All @@ -299,7 +301,7 @@
"welcome-cluster"
]
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"query": "",
"recent": false,
"search": true,
Expand Down Expand Up @@ -339,7 +341,7 @@
"content": "",
"mode": "markdown"
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -372,7 +374,7 @@
"content": "## Documentation and Support\n",
"mode": "markdown"
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -405,7 +407,7 @@
"content": "![](https://support.sas.com/en/support-home/_jcr_content/par/styledcontainer_1511041706/par/styledcontainer/par/styledcontainer_1517765672/par/image.img.png/1504883235316.png)\n",
"mode": "markdown"
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -438,7 +440,7 @@
"content": "## Other Dashboards\n",
"mode": "markdown"
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -468,10 +470,10 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "### SAS Viya\n\n* [Operations](https://documentation.sas.com/?softwareId=mysas&softwareVersion=prod&docsetId=k8sag&docsetTarget=p1n1sa2fm6xpr3n18dppwdpv6pfr.htm)\n* [Administration](https://documentation.sas.com/?softwareId=viyaadmin&softwareVersion=prod&docsetId=calmonitoring&docsetTarget=titlepage.htm&locale=en)\n* [SAS Technical Support](https://support.sas.com)\n",
"content": "### SAS Viya\n\n* [Operations](https://documentation.sas.com/?cdcId=itopscdc&cdcVersion=default&docsetId=itopswlcm&docsetTarget=home.htm)\n* [Administration](https://documentation.sas.com/?cdcId=sasadmincdc&cdcVersion=default&docsetId=sasadminwlcm&docsetTarget=home.htm)\n* [SAS Technical Support](https://support.sas.com)\n",
"mode": "markdown"
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -501,10 +503,10 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "### Get More Help\n\n * [SAS Viya Monitoring for Kubernetes Help Center](http://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default)\n* [SAS Viya Monitoring on GitHub](https://github.com/sassoftware/viya4-monitoring-kubernetes)\n* [View Open Issues](https://github.com/sassoftware/viya4-monitoring-kubernetes/issues)\n* [Report a New Issue](https://github.com/sassoftware/viya4-monitoring-kubernetes/issues/new)",
"content": "### Get More Help\n\n* [SAS Viya Monitoring for Kubernetes Help Center](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvwlcm&docsetTarget=titlepage.htm)\n* [SAS Viya Monitoring on GitHub](https://github.com/sassoftware/viya4-monitoring-kubernetes)\n* [View Open Issues](https://github.com/sassoftware/viya4-monitoring-kubernetes/issues)\n* [Report a New Issue](https://github.com/sassoftware/viya4-monitoring-kubernetes/issues/new)",
"mode": "markdown"
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -535,13 +537,14 @@
"keepTime": false,
"maxItems": 10,
"query": "",
"showFolderNames": true,
"showHeadings": true,
"showRecentlyViewed": true,
"showSearch": false,
"showStarred": true,
"tags": []
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"query": "",
"recent": true,
"search": false,
Expand Down Expand Up @@ -582,7 +585,7 @@
"content": "### Grafana\n\n* [Documentation](https://grafana.com/docs/grafana/latest)\n* [Tutorials](https://grafana.com/tutorials)\n* [Community Dashboards](https://grafana.com/grafana/dashboards/)",
"mode": "markdown"
},
"pluginVersion": "11.0.0",
"pluginVersion": "11.1.0",
"targets": [
{
"datasource": {
Expand All @@ -604,7 +607,6 @@
"from": "now-6h",
"to": "now"
},
"timeRangeUpdatedDuringEditOrView": false,
"timepicker": {
"hidden": true,
"refresh_intervals": [
Expand Down
2 changes: 1 addition & 1 deletion samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ each deployment file.
You customize your logging deployment by specifying values in `user.env` and
`*.yaml` files. These files are stored in a local directory outside of your
repository that is identified by the `USER_DIR` environment variable.
For information about the customization process, see [Pre-deployment](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=default&docsetId=obsrvdply&docsetTarget=n1ajbblsxpcgl5n11t13wgtd4d7c.htm) in the SAS Viya Monitoring for Kubernetes Help Center.
For information about the customization process, see [Create the Deployment Directory](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=p15fe8611w9njkn1fucwbvlz8tyg.htm) in the SAS Viya Monitoring for Kubernetes Help Center.

The customization files in each sample provide a starting point for the
customization files for a deployment that supports a specific situation.
Expand Down
Loading

0 comments on commit e0dddc9

Please sign in to comment.