mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-11-25 07:40:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: correct typos in struct field comments and release.md

Browse Source 
corrected strings in the release guide and util server.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
This commit is contained in:
Humble Chirammal 2022-04-07 17:04:25 +05:30 committed by mergify[bot]
parent 4100ad2406
commit 959df4dbac
4 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/development-guide.md
View File

@ -25,7 +25,7 @@ it is **highly** encouraged to:
package](https://github.com/ceph/go-ceph). It is required to install the package](https://github.com/ceph/go-ceph). It is required to install the
Ceph C headers in order to compile Ceph-CSI. The packages are called Ceph C headers in order to compile Ceph-CSI. The packages are called
`librados-devel` and `librbd-devel` on many Linux distributions. See the `librados-devel` and `librbd-devel` on many Linux distributions. See the
[go-ceph installaton [go-ceph installation
instructions](https://github.com/ceph/go-ceph#installation) for more instructions](https://github.com/ceph/go-ceph#installation) for more
details. details.
* Run * Run
@ -169,7 +169,7 @@ The `component` in the subject of the commit message can be one of the following
* `doc`: documentation updates * `doc`: documentation updates
* `util`: utilities shared between components use `cephfs` or `rbd` if the * `util`: utilities shared between components use `cephfs` or `rbd` if the
change is only relevant for one of the type of storage change is only relevant for one of the type of storage
* `journal`: any of the journalling functionalities * `journal`: any of the journaling functionalities
* `helm`: deployment changes for the Helm charts * `helm`: deployment changes for the Helm charts
* `deploy`: updates to Kubernetes templates for deploying components * `deploy`: updates to Kubernetes templates for deploying components
* `build`: anything related to building Ceph-CSI, the executable or container * `build`: anything related to building Ceph-CSI, the executable or container
@ -312,12 +312,12 @@ Right now, we also have below commands to manually retrigger the CI jobs
**Caution**: Please do not retrigger the CI jobs without an understanding of **Caution**: Please do not retrigger the CI jobs without an understanding of
the root cause, because: the root cause, because:
* We may miss some of the important corner cases which are true negatives, * We may miss some important corner cases which are true negatives,
and hard to reproduce and hard to reproduce
* Retriggering jobs for known failures can unnecessarily put CI resources * Retriggering jobs for known failures can unnecessarily put CI resources
under pressure under pressure
Hence it is recommended that you please go through the CI logs first, if you Hence, it is recommended that you please go through the CI logs first, if you
are certain about the flaky test failure behavior, then comment on the PR are certain about the flaky test failure behavior, then comment on the PR
indicating the logs about a particular test that went flaky and use the indicating the logs about a particular test that went flaky and use the
appropriate command to retrigger the job[s]. appropriate command to retrigger the job[s].

6
docs/metrics.md
View File

@ -26,10 +26,10 @@ Promethues can be deployed through the promethues operator described [here](http
The [service-monitor](../examples/service-monitor.yaml) will tell promethues how The [service-monitor](../examples/service-monitor.yaml) will tell promethues how
to pull metrics out of CSI. to pull metrics out of CSI.
Each CSI pod has a service to expose the endpoint to prometheus. By default rbd Each CSI pod has a service to expose the endpoint to prometheus. By default, rbd
pods run on port 8080 and cephfs 8081. pods run on port 8080 and cephfs 8081.
These can be changed if desired or if multiple ceph clusters are deployed more These can be changed if desired or if multiple ceph clusters are deployed more
ports will be used for additional CSI pods. ports will be used for additional CSI pods.
Note: You may need to open the ports used in your firewall depending on how you Note: You may need to open the ports used in your firewall depending on how your
cluster is setup. cluster has set up.

2
docs/releases.md
View File

@ -41,7 +41,7 @@ and it must be backward compatible.
- When `MAJOR` increases, the new release adds **new features, - When `MAJOR` increases, the new release adds **new features,
bug fixes, or both** and which *changes the behavior from bug fixes, or both** and which *changes the behavior from
the previous release* (may be backward incompatible). the previous release* (maybe backward incompatible).
## Tagging repositories ## Tagging repositories

8
internal/util/util.go
View File

@ -90,7 +90,7 @@ type Config struct {
EnableGRPCMetrics bool // option to enable grpc metrics EnableGRPCMetrics bool // option to enable grpc metrics
EnableProfiling bool // flag to enable profiling EnableProfiling bool // flag to enable profiling
IsControllerServer bool // if set to true start provisoner server IsControllerServer bool // if set to true start provisioner server
IsNodeServer bool // if set to true start node server IsNodeServer bool // if set to true start node server
Version bool // cephcsi version Version bool // cephcsi version
@ -164,7 +164,7 @@ type KernelVersion struct {
SubLevel int SubLevel int
ExtraVersion int // prefix of the part after the first "-" ExtraVersion int // prefix of the part after the first "-"
Distribution string // component of full extraversion Distribution string // component of full extraversion
Backport bool // backports have a fixed version/patchlevel/sublevel Backport bool // backport have a fixed version/patchlevel/sublevel
} }
// parseKernelRelease parses a kernel release version string into: // parseKernelRelease parses a kernel release version string into:
@ -202,9 +202,9 @@ func parseKernelRelease(release string) (int, int, int, int, error) {
// CheckKernelSupport checks the running kernel and comparing it to known // CheckKernelSupport checks the running kernel and comparing it to known
// versions that have support for required features . Distributors of // versions that have support for required features . Distributors of
// enterprise Linux have backported quota support to previous versions. This // enterprise Linux have backport quota support to previous versions. This
// function checks if the running kernel is one of the versions that have the // function checks if the running kernel is one of the versions that have the
// feature/fixes backported. // feature/fixes backport.
// //
// `uname -r` (or Uname().Utsname.Release has a format like 1.2.3-rc.vendor // `uname -r` (or Uname().Utsname.Release has a format like 1.2.3-rc.vendor
// This can be slit up in the following components: - version (1) - patchlevel // This can be slit up in the following components: - version (1) - patchlevel