Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PowerScale Obs doc update for CSM Observability 1.3.0 #322

Merged
merged 1 commit into from
Aug 24, 2022

Conversation

baoy1
Copy link
Contributor

@baoy1 baoy1 commented Aug 22, 2022

Description

Add CSM observability for PowerScale to csm-docs, and update docs for online/offline install and upgrade.

GitHub Issues

List the GitHub issues impacted by this PR:

GitHub Issue #
dell/csm#452

Checklist:

  • Have you run a grammar and spell checks against your submission?
  • Have you tested the changes locally?
  • Have you tested whether the hyperlinks are working properly?
  • Did you add the examples wherever applicable?
  • Have you added high-resolution images?

taohe1012
taohe1012 previously approved these changes Aug 22, 2022
@baoy1 baoy1 force-pushed the feature-429-csm-obs-powerscale branch 2 times, most recently from d738e38 to df5df5b Compare August 22, 2022 04:34
taohe1012
taohe1012 previously approved these changes Aug 22, 2022
@@ -14,13 +14,14 @@ Description: >

Metrics data is collected and pushed to the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector), so it can be processed, and exported in a format consumable by Prometheus. SSL certificates for TLS between nodes are handled by [cert-manager](https://github.com/jetstack/cert-manager).

CSM for Observability is composed of several services, each living in its own GitHub repository, that can be installed following one of the three deployments we support [here](deployment). Contributions can be made to this repository or any of the CSM for Observability repositories listed below.
CSM for Observability is composed of several services, each living in its own GitHub repository, that can be installed following one of the four deployments we support [here](deployment). Contributions can be made to this repository or any of the CSM for Observability repositories listed below.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete "below"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

{{<table "table table-striped table-bordered table-sm">}}

Probably github cannot render the HTML tag properly. Same for other branches, e.g. release-1.4-updated.
After publishing the doc using hugo, the HTML is correct, see http://10.225.6.31:1313/csm-docs/docs/observability/


`kubectl get secret isilon-creds -n [CSI_DRIVER_NAMESPACE] -o yaml | sed 's/namespace: [CSI_DRIVER_NAMESPACE]/namespace: [CSM_NAMESPACE]/' | kubectl create -f -`

If [CSM for Authorization is enabled](../../../authorization/deployment/#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerScale, perform the following steps:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change "the following" to "these"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Address.

## Offline Installer Upgrade

Assuming that you have already installed the Karavi Observability Helm Chart by offline installer and meet its installation requirement.
The following instructions can be followed when a Helm chart was installed and will be upgraded in an environment that does not have an internet connection and will be unable to download the Helm chart and related Docker images.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change "The following" to "These"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Address.

Copy link

@rsedlock1958 rsedlock1958 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have reviewed this. Minor edits required.

@baoy1 baoy1 force-pushed the feature-429-csm-obs-powerscale branch from df5df5b to 83ca75f Compare August 22, 2022 14:47
@baoy1
Copy link
Contributor Author

baoy1 commented Aug 22, 2022

I have reviewed this. Minor edits required.

All addressed. Thank you!

@baoy1
Copy link
Contributor Author

baoy1 commented Aug 24, 2022

Hi @rsedlock1958 , @gallacher, @mjsdell , @prablr79, @rajendraindukuri, @shanmydell, any more comments prior to your approvals?

@shanmydell shanmydell merged commit 6b783f3 into release-1.4-updated Aug 24, 2022
@shanmydell shanmydell deleted the feature-429-csm-obs-powerscale branch August 24, 2022 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants