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

docs: Fix typos, grammar and adjust icons #5

Merged
merged 6 commits into from
Jun 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ community looks forward to your contributions. 🎉
> the project and show your appreciation, which we would also be very happy about:
> - Star the project
> - Tweet about it
> - Refer this project in your project's readme
> - Refer this project in your project's README
> - Mention the project at local meetups and tell your friends/colleagues

## Table of Contents
Expand All @@ -21,7 +21,7 @@ community looks forward to your contributions. 🎉
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Your First Code Contribution](#your-first-code-contribution)
- [Styleguides](#styleguides)
- [Style guides](#style-guides)
- [Pull requests](#pull-requests)


Expand Down Expand Up @@ -134,7 +134,7 @@ pre-commit install
The hooks are set up to perform basic validations on your code, like fixing newlines at the end of a file or linting
changed helm files.

## Styleguides
## Style guides

### Pull requests

Expand Down
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# ionoscloud-blockstorage-csi-driver

![image-version] ![chart-version]

<p align="center">
<img src="https://raw.githubusercontent.com/container-storage-interface/spec/master/logo.png" width="80" style="vertical-align: middle;">
<img src="./docs/assets/images/LOGO_IONOS_Blue_RGB.png" width="200" style="vertical-align: middle;">
<img src="https://raw.githubusercontent.com/container-storage-interface/spec/master/logo.png" width="200">
<img src="./docs/assets/images/LOGO_IONOS_Blue_RGB.png" width="200">
</p>

Container Storage Interface (CSI) plugin for IONOS Cloud [block storage][1].
Expand Down Expand Up @@ -36,3 +38,6 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
[4]: https://kubernetes.io/docs/concepts/storage/storage-classes/#the-storageclass-resource
[5]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#expanding-persistent-volumes-claims
[6]: https://kubernetes.io/docs/concepts/storage/volume-snapshots

[image-version]: <https://ghcr-badge.egpl.dev/ionos-cloud/ionoscloud-blockstorage-csi-driver/latest_tag?label=app version>
[chart-version]: <https://ghcr-badge.egpl.dev/ionos-cloud/helm-charts/ionoscloud-blockstorage-csi-driver/latest_tag?label=chart version>
4 changes: 2 additions & 2 deletions charts/ionoscloud-blockstorage-csi-driver/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
apiVersion: v2
name: ionoscloud-blockstorage-csi-driver
description: IONOS Cloud Container Storage Interface (CSI) driver.
description: Container Storage Interface (CSI) driver for IONOS Cloud block storage.
type: application
keywords:
- csi
- ionos-cloud
version: 0.1.0
version: 0.1.1
appVersion: "v1.7.0-rc.0"
kubeVersion: ">=1.20.0-0"
home: https://github.com/ionos-cloud/ionoscloud-blockstorage-csi-driver
Expand Down
24 changes: 6 additions & 18 deletions charts/ionoscloud-blockstorage-csi-driver/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,10 @@
# ionoscloud-blockstorage-csi-driver

![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v1.7.0-rc.0](https://img.shields.io/badge/AppVersion-v1.7.0--rc.0-informational?style=flat-square)

IONOS Cloud Container Storage Interface (CSI) driver.
![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v1.7.0-rc.0](https://img.shields.io/badge/AppVersion-v1.7.0--rc.0-informational?style=flat-square)

**Homepage:** <https://github.com/ionos-cloud/ionoscloud-blockstorage-csi-driver>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| avorima | | <https://github.com/avorima> |

## Source Code

* <https://github.com/ionos-cloud/ionoscloud-blockstorage-csi-driver>

The [Container Storage Interface][csi-spec] (CSI) driver plugin communicates with the [IONOS Cloud API][cloud-api] to manage storages.
The [Container Storage Interface][csi-spec] (CSI) driver plugin communicates with the [IONOS Cloud API][cloud-api] to manage storage.
The visibility and permissions it has depend on the authentication token it is given.

Check out [this page][token-docs] to learn more about managing tokens.
Expand Down Expand Up @@ -51,11 +39,11 @@ helm install -n kube-system ionoscloud-csi-driver oci://ghcr.io/ionos-cloud/helm
```

> [!IMPORTANT]
> Be aware that tokens have a limited liftime. The CSI controller deployment needs to restarted every time the token is updated.
> Be aware that tokens have a limited lifetime. The CSI controller deployment needs to be restarted every time the token is updated.

### Multi-tenancy setup

The default settings of CSI driver helm chart are meant to be used in a single-tenancy manner.
The default settings of the CSI driver helm chart are meant to be used in a single-tenancy manner.
Should you need to install multiple CSI drivers using tokens from the same users or contracts, e.g. if you manage more than 1 cluster,
you need to set the `clusterName` value on installation.

Expand Down Expand Up @@ -105,7 +93,7 @@ helm install -n kube-system ionoscloud-csi-driver oci://ghcr.io/ionos-cloud/helm
| deployment.podSecurityContext | object | `{}` | Security context for Deployment pods. |
| deployment.replicaCount | int | `1` | Number of Deployment pods. Setting this higher than 1 will enable leader election. |
| deployment.securityContext | object | `{"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true}` | Security context for Deployment containers. |
| deployment.tolerations | list | `[]` | Tolerations for Deployemnt pods. |
| deployment.tolerations | list | `[]` | Tolerations for Deployment pods. |

### Controller server

Expand Down Expand Up @@ -135,7 +123,7 @@ helm install -n kube-system ionoscloud-csi-driver oci://ghcr.io/ionos-cloud/helm
|-----|------|---------|-------------|
| monitoring.additionalLabels | object | `{}` | Additional labels for the PodMonitor. |
| monitoring.enabled | bool | `false` | If true, render Prometheus PodMonitor resource. |
| monitoring.nameOverride | string | `""` | Speciy name override for the PodMonitor. |
| monitoring.nameOverride | string | `""` | Specify name override for the PodMonitor. |
| monitoring.namespace | string | Release namespace | Specify namespace override for the PodMonitor. |
| monitoring.scrapeInterval | string | `"30s"` | Metrics scrape interval as duration string. |

Expand Down
12 changes: 3 additions & 9 deletions charts/ionoscloud-blockstorage-csi-driver/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@

{{ template "chart.badgesSection" . }}

{{ template "chart.description" . }}

{{ template "chart.homepageLine" . }}

{{ template "chart.maintainersSection" . }}

{{ template "chart.sourcesSection" . }}

The [Container Storage Interface][csi-spec] (CSI) driver plugin communicates with the [IONOS Cloud API][cloud-api] to manage storages.
The [Container Storage Interface][csi-spec] (CSI) driver plugin communicates with the [IONOS Cloud API][cloud-api] to manage storage.
The visibility and permissions it has depend on the authentication token it is given.

Check out [this page][token-docs] to learn more about managing tokens.
Expand Down Expand Up @@ -45,11 +39,11 @@ helm install -n kube-system ionoscloud-csi-driver oci://ghcr.io/ionos-cloud/helm
```

> [!IMPORTANT]
> Be aware that tokens have a limited liftime. The CSI controller deployment needs to restarted every time the token is updated.
> Be aware that tokens have a limited lifetime. The CSI controller deployment needs to be restarted every time the token is updated.

### Multi-tenancy setup

The default settings of CSI driver helm chart are meant to be used in a single-tenancy manner.
The default settings of the CSI driver helm chart are meant to be used in a single-tenancy manner.
Should you need to install multiple CSI drivers using tokens from the same users or contracts, e.g. if you manage more than 1 cluster,
you need to set the `clusterName` value on installation.

Expand Down
4 changes: 2 additions & 2 deletions charts/ionoscloud-blockstorage-csi-driver/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ deployment:
# -- Node selector for Deployment pods.
# @section -- Deployment
nodeSelector: {}
# -- Tolerations for Deployemnt pods.
# -- Tolerations for Deployment pods.
# @section -- Deployment
tolerations: []
# -- Affinity for Deployment pods.
Expand Down Expand Up @@ -301,7 +301,7 @@ monitoring:
# -- If true, render Prometheus PodMonitor resource.
# @section -- Monitoring
enabled: false
# -- Speciy name override for the PodMonitor.
# -- Specify name override for the PodMonitor.
# @section -- Monitoring
nameOverride: ""
# -- Specify namespace override for the PodMonitor.
Expand Down