Skip to content

Commit

Permalink
Fix spelling (openebs#2755)
Browse files Browse the repository at this point in the history
Signed-off-by: Hugo <hugovk@users.noreply.github.com>
  • Loading branch information
hugovk authored and Amit Kumar Das committed Oct 3, 2019
1 parent 8a43156 commit ea7b47e
Show file tree
Hide file tree
Showing 26 changed files with 35 additions and 35 deletions.
2 changes: 1 addition & 1 deletion GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ becomes a maintainer once the pull request is merged.
Similar to adding maintainers, new sub projects can be added to OpenEBS
GitHub organization as long as they adhere to the OpenEBS vision and mission.
New projects are discussed in either the Contributor Meeting or the Community
slack and requires atleast 1 maintainer approval.
slack and requires at least 1 maintainer approval.

If a project is approved, a maintainer will add the project to the OpenEBS
GitHub organization, and make an announcement on a public forum.
Expand Down
2 changes: 1 addition & 1 deletion NOTICE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ The source code developed under the OpenEBS Project is licensed under Apache 2.0

However, the OpenEBS project contains unmodified/modified subcomponents from other Open Source Projects with separate copyright notices and license terms. Your use of the source code for these subcomponents is subject to the terms and conditions as defined by those source projects.

OpenEBS uses [FOSSA](https://app.fossa.com) to perform license scan on all its projects. The links to the auto-generated FOSSA reports on the 3rd Party Softwares used by each of the OpeneBS project are listed below:
OpenEBS uses [FOSSA](https://app.fossa.com) to perform license scan on all its projects. The links to the auto-generated FOSSA reports on the 3rd Party Software used by each of the OpeneBS project are listed below:

| Component | Repo Link | License | Dependency and Notes
|---|---|---|---|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ status:
#### ConfigInjector -- new custom resource
This is a new Kubernetes custom resource whose object will get created by cstor
volume claim controller. This resource gets built and applied by cstor volume
claim controller after refering to `CStorVolumeConfigClass`.
claim controller after referring to `CStorVolumeConfigClass`.

ConfigInjector kind has its dedicated controller residing in maya api
server. The job of this controller is to inject infrastructure related
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

---
oep-number: draft Auto Snapshot deltion 20190715
oep-number: draft Auto Snapshot deletion 20190715
title: Jiva auto snapshot deletion
authors:
- "@utkarshmani1997"
Expand Down
4 changes: 2 additions & 2 deletions k8s/jiva/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ NAME CAPACITY ACCESS MODES RECLAIM POL
pvc-d01e90d9-a921-11e9-93c2-42010a8000ab 5G RWO Delete Bound default/demo-vol1-claim openebs-jiva-default 10m
```

The following script will execute when number of Jiva auto-generated snapshots are more than 5. Else, it will exit. This means, minimum availble snapshot will be always more than 5. For example, if total number of Jiva auto-generated snapshots are 20 and required number of snapshot to be deleted is 15, then this script will not work. In this case, the script will work if you give 14 instead of 15 as the number of snapshots to be deleted.
The following script will execute when number of Jiva auto-generated snapshots are more than 5. Else, it will exit. This means, minimum available snapshot will be always more than 5. For example, if total number of Jiva auto-generated snapshots are 20 and required number of snapshot to be deleted is 15, then this script will not work. In this case, the script will work if you give 14 instead of 15 as the number of snapshots to be deleted.

**Note:**

Expand All @@ -92,7 +92,7 @@ Example:
./snapshot-cleanup.sh pvc-d01e90d9-a921-11e9-93c2-42010a8000ab 12
```

In the above example, 12 snapshots will be deleted from the total number of the auto-generated snapshots of the volume. After deleteing mentioned number of snapshots, total number of auto generated snapshot will be (old total number- given number for deletion) + (total number of replica -1). In this example, (21-12)+2=11
In the above example, 12 snapshots will be deleted from the total number of the auto-generated snapshots of the volume. After deleting mentioned number of snapshots, total number of auto generated snapshot will be (old total number- given number for deletion) + (total number of replica -1). In this example, (21-12)+2=11

**Note:** In case of unexpected disconnect during the cleanup process, you will have to run the following command to restore the volume service.
```
Expand Down
4 changes: 2 additions & 2 deletions k8s/jiva/snapshot-cleanup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ warning()
fi
}

# spin prints ('|','/','-','\','|') in cyclic order while snapshot deletion is in progres.
# spin prints ('|','/','-','\','|') in cyclic order while snapshot deletion is in progress.
spin()
{
while true
Expand Down Expand Up @@ -86,7 +86,7 @@ unblock_service()
rm tmp.json
}

# restart_ctrl restart the contoller pod
# restart_ctrl restart the controller pod
restart_ctrl()
{
kubectl delete pod $ctrl_pod_name -n $pvc_namespace
Expand Down
2 changes: 1 addition & 1 deletion k8s/lib/vagrant/boxes/k8s/cleanup_k8s.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ if [ "$distribution" = "ubuntu" ]; then

# Remove the deb packages from the /vagrant/ folder.
rm -rf /vagrant/workdir/debpkgs
# Cleaning up apt and bash history before packaing the box.
# Cleaning up apt and bash history before packaging the box.
sudo mkdir -p /etc/systemd/system/apt-daily.timer.d/
cat <<EOF | sudo tee -a /etc/systemd/system/apt-daily.timer.d/apt-daily.timer.conf > /dev/null
[Timer]
Expand Down
2 changes: 1 addition & 1 deletion k8s/lib/vagrant/boxes/openebs/cleanup_openebs.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

# Cleaning up apt and bash history before packaing the box.
# Cleaning up apt and bash history before packaging the box.
sudo mkdir -p /etc/systemd/system/apt-daily.timer.d/
cat <<EOF | sudo tee -a /etc/systemd/system/apt-daily.timer.d/apt-daily.timer.conf > /dev/null
[Timer]
Expand Down
2 changes: 1 addition & 1 deletion k8s/lib/vagrant/patch/patch_k8s.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ cp ${scriptloc}/configure_k8s_weave.sh .


# DONOT MODIFY BELOW THIS LINE
# Cleaning up apt and bash history before packaing the box.
# Cleaning up apt and bash history before packaging the box.
sudo mkdir -p /etc/systemd/system/apt-daily.timer.d/
cat <<EOF | sudo tee -a /etc/systemd/system/apt-daily.timer.d/apt-daily.timer.conf > /dev/null
[Timer]
Expand Down
4 changes: 2 additions & 2 deletions k8s/lib/vagrant/patch/patch_openebs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@


# DONOT MODIFY BELOW THIS LINE
# Cleaning up apt and bash history before packaing the box.
# Cleaning up apt and bash history before packaing the box.
# Cleaning up apt and bash history before packaging the box.
# Cleaning up apt and bash history before packaging the box.
sudo mkdir -p /etc/systemd/system/apt-daily.timer.d/
cat <<EOF | sudo tee -a /etc/systemd/system/apt-daily.timer.d/apt-daily.timer.conf > /dev/null
[Timer]
Expand Down
2 changes: 1 addition & 1 deletion k8s/upgrades/0.4.0-0.5.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ replicaset "pvc-8cc9c06c-ea22-11e7-9112-000c298ff5fc-ctrl-59df76689f" deleted
PV and patches the volume deployments using the ```kubectl patch deployment``` command.
In each case, it verifies whether the new images have been rolled out successfully, using ```kubectl rollout status deployment```
before proceeding to the next step. Post patching, it also deletes the orphaned replicaset of the controller deployment as a
woraround for this issue : https://github.com/openebs/openebs/issues/1201
workaround for this issue : https://github.com/openebs/openebs/issues/1201


Verify that the volume controller and replica pods are running post upgrade
Expand Down
4 changes: 2 additions & 2 deletions k8s/upgrades/0.6.0-0.7.0/oebs_update.sh
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ r_rs=$(kubectl get rs -o name --namespace $ns | grep $r_dep | cut -d '/' -f 2)


# PATCH JIVA REPLICA DEPLOYMENT ####
echo "Remove deprecated lables from Replica Deployment"
echo "Remove deprecated labels from Replica Deployment"
kubectl patch deployment --namespace $ns $r_dep --type json -p "$(cat replica-patch-remove-labels.json)"
rc=$?; if [ $rc -ne 0 ]; then echo "ERROR: $rc"; exit; fi

Expand All @@ -168,7 +168,7 @@ rc=$?; if [[ ($rc -ne 0) || !($rollout_status =~ "successfully rolled out") ]];
then echo "ERROR: $rc"; exit; fi

#### PATCH TARGET DEPLOYMENT ####
echo "Remove deprecated lables from Controller Deployment"
echo "Remove deprecated labels from Controller Deployment"
kubectl patch deployment --namespace $ns $c_dep --type json -p "$(cat target-patch-remove-labels.json)"
rc=$?; if [ $rc -ne 0 ]; then echo "ERROR: $rc"; exit; fi

Expand Down
2 changes: 1 addition & 1 deletion k8s/upgrades/0.8.0-0.8.1/cstor_pool_post_upgrade.sh
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ done

if [ $retry == true ]; then
echo "Post upgrade for $spc is failed."
echo "Please retry by runnig ./$0 $spc $ns"
echo "Please retry by running ./$0 $spc $ns"
exit 1
fi

Expand Down
2 changes: 1 addition & 1 deletion k8s/upgrades/0.8.0-0.8.1/cstor_pool_upgrade.sh
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ for csp in `echo $csp_list | tr ":" " "`; do
fi
## Patching the csp resource
kubectl patch csp $csp -p "$(cat cr_patch.json)" --type=merge
rc=$?; if [ $rc -ne 0 ]; then echo "Error occured while upgrading the csp: $csp Exit Code: $rc"; exit; fi
rc=$?; if [ $rc -ne 0 ]; then echo "Error occurred while upgrading the csp: $csp Exit Code: $rc"; exit; fi
done

echo "Patching Pool Deployment with new image"
Expand Down
2 changes: 1 addition & 1 deletion k8s/upgrades/0.8.0-0.8.1/cstor_volume_upgrade.sh
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ sed "s/@sc_name@/$sc_name/g" cstor-volume-replica-patch.tpl.json | sed "s/@sc_re
if [[ "$controller_version" != "$target_upgrade_version" ]]; then
echo "Upgrading Target Deployment to $target_upgrade_version"

# Setting deployment startegy to recreate
# Setting deployment strategy to recreate
setDeploymentRecreateStrategy $ns $c_dep

kubectl patch deployment --namespace $ns $c_dep -p "$(cat cstor-target-patch.json)"
Expand Down
2 changes: 1 addition & 1 deletion k8s/upgrades/0.8.1-0.8.2/cstor_pool_upgrade.sh
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ for csp in `echo $csp_list | tr ":" " "`; do
fi
## Patching the csp resource
kubectl patch csp $csp -p "$(cat cr_patch.json)" --type=merge
rc=$?; if [ $rc -ne 0 ]; then echo "Error occured while upgrading the csp: $csp Exit Code: $rc"; exit; fi
rc=$?; if [ $rc -ne 0 ]; then echo "Error occurred while upgrading the csp: $csp Exit Code: $rc"; exit; fi
done

echo "Patching Pool Deployment with new image"
Expand Down
2 changes: 1 addition & 1 deletion k8s/upgrades/0.8.2-0.9.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Limitations:


# OpenEBS upgrade via CASTemplates from 0.8.2 to 0.9.0
**NOTE: Upgrade via these CAS Templates is ony supported for OpenEBS in version 0.8.2. Trying to upgrade a OpenEBS version other than 0.8.2 to 0.9.0 using these CAS templates can result in undesired behaviours. If you are having any OpenEBS version lower than 0.8.2, first upgrade it ot 0.8.2 and then these CAS templates can be used safely for 0.9.0 upgrade.**
**NOTE: Upgrade via these CAS Templates is only supported for OpenEBS in version 0.8.2. Trying to upgrade a OpenEBS version other than 0.8.2 to 0.9.0 using these CAS templates can result in undesired behaviours. If you are having any OpenEBS version lower than 0.8.2, first upgrade it to 0.8.2 and then these CAS templates can be used safely for 0.9.0 upgrade.**

## Upgrade Jiva based volumes

Expand Down
4 changes: 2 additions & 2 deletions k8s/upgrades/0.8.2-0.9.0/cstor/cstor-pool-update-082-090.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ spec:
- upgrade-cstor-pool-082-090-get-storagepool

# Runtask #4
# This runtask puts result od resource into upgraderesult custom resource
# This runtask puts result of resource into upgraderesult custom resource
# after getting info via above 3 runtasks.
- upgrade-cstor-pool-082-090-patch-upgrade-result

Expand Down Expand Up @@ -450,7 +450,7 @@ spec:
{{- $status := "" -}}
{{- $message :="" -}}
{{- $verifyErrMessage := "Pool deployment rollout not successfull" -}}
{{- $verifyErrMessage := "Pool deployment rollout not successful" -}}
{{- $rolloutStatusMessage := printf "rollout status: {%s} name: {%s} namespace: {%s}" .TaskResult.patchDeploymentImageStatus.rolloutStatus .UpgradeItem.name .UpgradeItem.namespace -}}
{{- if eq .TaskResult.patchDeploymentImageStatus.isRolledout "true" }}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,7 @@ spec:
{{- jsonpath .JsonResult "{.message}" | trim | saveAs "postCheckDeploymentRollout.rolloutStatus" .TaskResult | noop -}}
{{- $status := "" -}}
{{- $verifyErrMessage := "Target deployment roll out not successfull" -}}
{{- $verifyErrMessage := "Target deployment roll out not successful" -}}
{{- if eq .TaskResult.postCheckDeploymentRollout.isRolledout "true" }}
{{- $status = .Config.successStatus.value -}}
Expand Down
2 changes: 1 addition & 1 deletion k8s/upgrades/0.8.2-0.9.0/cstor/pool-upgrade-job.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ data:
- name: cstor-sparse-pool-dwc3
kind: cStorPool
namespace: openebs
# Similiary, you can fill details below for other cstorpool
# Similarity, you can fill details below for other cstorpool
# upgrades.
# If not required, delete it.
- name: cstor-sparse-pool-efx5
Expand Down
4 changes: 2 additions & 2 deletions k8s/upgrades/0.9.0-1.0.0/cstor/verify_pool_upgrade.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ upgrade_version="1.0.0"
current_version="0.9.0"


## No need to catch kubectl command errors becase we need to continue with
## No need to catch kubectl command errors because we need to continue with
## other checks
source util.sh

Expand Down Expand Up @@ -117,7 +117,7 @@ sp_list=$(kubectl get sp -l openebs.io/storage-pool-claim=$spc \
sp_count=$(echo $sp_list | wc -w)

if [ $sp_count != 0 ]; then
echo "SP is deprecated for cStor but stil it is available in cluster. SP {$sp_list} list"
echo "SP is deprecated for cStor but still it is available in cluster. SP {$sp_list} list"
is_upgrade_failed=1
fi

Expand Down
2 changes: 1 addition & 1 deletion k8s/upgrades/0.9.0-1.0.0/pre-upgrade.sh
Original file line number Diff line number Diff line change
Expand Up @@ -330,4 +330,4 @@ if [ $install_option == "operator" ]; then
fi
fi

echo "Pre-Upgrade is successfull Please update openebs components"
echo "Pre-Upgrade is successful Please update openebs components"
2 changes: 1 addition & 1 deletion k8s/upgrades/dev/cstor_pool_upgrade.sh
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ for csp in `echo $csp_list | tr ":" " "`; do
fi
## Patching the csp resource
kubectl patch csp $csp -p "$(cat cr_patch.json)" --type=merge
rc=$?; if [ $rc -ne 0 ]; then echo "Error occured while upgrading the csp: $csp Exit Code: $rc"; exit; fi
rc=$?; if [ $rc -ne 0 ]; then echo "Error occurred while upgrading the csp: $csp Exit Code: $rc"; exit; fi
done

echo "Patching Pool Deployment with new image"
Expand Down
4 changes: 2 additions & 2 deletions k8s/upgrades/dev/cstor_volume_upgrade.sh
Original file line number Diff line number Diff line change
Expand Up @@ -75,15 +75,15 @@ fi

## 2. Update cstorvolume patch file with volume upgrade version.
## if cstorvolume(cv_name) name is nil, update the patch file only with version
## details, elsse update patch file with version and source-volume lable details
## details, elsse update patch file with version and source-volume label details
if [ -z $cv_name ]; then
sed "s|\"openebs.io/source-volume\": \"@sourcevolume@\",||g" cstor-volume-patch.tpl.json | sed "s|@target_version@|$volume_upgrade_version|g" > cstor-volume-patch.json
else
sed "s|@sourcevolume@|$cv_name|g" cstor-volume-patch.tpl.json | sed "s/@target_version@/$volume_upgrade_version/g" > cstor-volume-patch.json
fi
## 3. Patching the cstorvolume resource
kubectl patch cstorvolume $pv -n $ns -p "$(cat cstor-volume-patch.json)" --type=merge
rc=$?; if [ $rc -ne 0 ]; then echo "Error occured while upgrading cstorvolume: $cv_name Exit Code: $rc"; exit; fi
rc=$?; if [ $rc -ne 0 ]; then echo "Error occurred while upgrading cstorvolume: $cv_name Exit Code: $rc"; exit; fi

## 4. Remove the temporary patch file
rm cstor-volume-patch.json
Expand Down
2 changes: 1 addition & 1 deletion k8s/upgrades/dev/snapshotdata_upgrade.sh
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ run_snapshotdata_upgrades()
for snapdata_name in `echo $volumesnapshotdata_list | tr ":" " "`; do
## patch volumesnapshotdata cr ###
kubectl patch volumesnapshotdata $snapdata_name -p "$(cat volumesnapshotdata-patch.json)" --type=merge
rc=$?; if [ $rc -ne 0 ]; then echo "Error occured while upgrading volumesnapshotdata name: $snapdata_name Exit Code: $rc"; exit; fi
rc=$?; if [ $rc -ne 0 ]; then echo "Error occurred while upgrading volumesnapshotdata name: $snapdata_name Exit Code: $rc"; exit; fi
done
## Removes temporary file
rm volumesnapshotdata-patch.json
Expand Down
6 changes: 3 additions & 3 deletions k8s/upgrades/jiva-0.6.0-0.8.1/jiva_volume_upgrade.sh
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ kubectl annotate pv $pv openebs.io/cas-type=jiva

controller_version=`kubectl get deployment $c_dep -n $ns -o jsonpath='{.metadata.labels.openebs\.io/version}'`
if [[ "$controller_version" == "$target_upgrade_version" ]]; then
echo "Remove deprecated lables from Controller Deployment"
echo "Remove deprecated labels from Controller Deployment"
c_rs=$(kubectl get rs -o name --namespace $ns -l openebs.io/persistent-volume=$pv,openebs.io/controller=jiva-controller | cut -d '/' -f 2)

kubectl patch deployment --namespace $ns $c_dep --type json -p "$(cat target-patch-remove-labels.json)"
Expand All @@ -225,7 +225,7 @@ fi

replica_version=`kubectl get deployment $r_dep -n $ns -o jsonpath='{.metadata.labels.openebs\.io/version}'`
if [[ "$replica_version" == "$target_upgrade_version" ]]; then
echo "Remove deprecated lables from Replica Deployment"
echo "Remove deprecated labels from Replica Deployment"
r_rs=$(kubectl get rs -o name --namespace $ns -l openebs.io/persistent-volume=$pv,openebs.io/replica=jiva-replica | cut -d '/' -f 2)


Expand All @@ -242,7 +242,7 @@ fi

controller_svc_version=`kubectl get svc $c_svc -n $ns -o jsonpath='{.metadata.labels.openebs\.io/version}'`
if [[ "$controller_svc_version" == "$target_upgrade_version" ]] ; then
echo "Remove deprecated lables from Replica Deployment"
echo "Remove deprecated labels from Replica Deployment"
kubectl patch service --namespace $ns $c_svc --type json -p "$(cat target-svc-patch-remove-labels.json)"
rc=$?; if [ $rc -ne 0 ]; then echo "ERROR: $rc"; exit; fi
kubectl label svc --namespace $ns $c_svc "vsm-"
Expand Down

0 comments on commit ea7b47e

Please sign in to comment.