Skip to content

Commit

Permalink
Update README.md and release fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
SergeAlexandre committed Feb 10, 2021
1 parent 8a85e8e commit c5873f3
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 10 deletions.
2 changes: 0 additions & 2 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ release:
prerelease: true
extra_files:
- glob: pvscanner/kubernetes/kustomized/deploy.yaml
- glob: vgsd/vgsd
- glob: vgsd/systemd/vgsd.service
archives:
- replacements:
darwin: Darwin
Expand Down
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,11 @@ On top of that, `pvdf` integrate some special handling for volumes generated by

## Installation

To install pvdf, you need an account with full admin privileges. Then:
`pvdf` is made of two components: A Daemonset, which regulary scan disk usage and store them as annotation, and a client, which collect these informations to present them in a user friendly way.

### Daemonset installation

To install the `pvdf` daemonset (`pvscanner`), you need an account with full admin privileges. Then:

```
kubectl apply -f https://github.com/BROADSoftware/pvdf/releases/download/v0.2.0/deploy.yaml
Expand All @@ -59,9 +63,9 @@ pvscanner-xmhc7 1/1 Running 0 87m
```
You should have one pod per node (Except the ones of the Control Plane).

### `pvdf` client installation
### Client installation

Several client implementation are provided depending of your architecture. Below is an installation example for Linux:
Several client implementation are provided depending on your architecture. Below is an installation example for Linux:

```
$ cd /tmp
Expand Down Expand Up @@ -120,7 +124,7 @@ Flags:
Use "pvdf [command] --help" for more information about a command.
```

The other main command is `topolvm`, to be used if this feature is installed.
The other main command is `topolvm`, to be used if this kubernetes CSI plugin is installed. More info [here](https://github.com/topolvm/topolvm)

```
$ pvdf topolvm --unit Gi
Expand Down Expand Up @@ -192,7 +196,7 @@ Note than the **REQ.** column is not impacted by this unit option, as it is in f

The output can also be provided in JSON form, using the `--format json` option.

As this output is not formatted, better to pipe in a tool like `jq`
As this output is not formatted, you can pipe the result in a tool like `jq`

```
$ pvdf pv --format json | jq
Expand Down Expand Up @@ -239,8 +243,8 @@ Please take note of the following regarding storage values accuracy:

### pvscanner

This is a daemonset which lookup all mounted volumes related to a PersisentVolume to perform an `fstats` unix system call on each.
Then it store the resulting values in these annotations:
This is a daemonset which lookup all mounted volumes related to a PersistentVolume to perform an `fstats` unix system call on each.
Then it stores the resulting values in these annotations:

- `pvscanner.pvdf.broadsoftware.com/free_mib`
- `pvscanner.pvdf.broadsoftware.com/size_mib`
Expand Down
3 changes: 2 additions & 1 deletion release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,11 @@ cd $BASE || exit

cd $BASE/pvscanner/kubernetes || exit
cat <<EOF >./kustomization.yaml
# release.sh generated file. Do not edit
resources:
- deploy.yaml
EOF
kustomize edit set image pvdf/pvscanner=pvdf/pvscanner:$VERSION
kustomize edit set image registry.gitlab.com/pvdf/pvscanner=registry.gitlab.com/pvdf/pvscanner:$VERSION
mkdir -p kustomized
kustomize build . >./kustomized/deploy.yaml

Expand Down

0 comments on commit c5873f3

Please sign in to comment.