Skip to content

Commit 057a349

Browse files
authored
Clean spelling and ignore generated scripts (#11)
Signed-off-by: Josh Minor <[email protected]> Signed-off-by: Josh Minor <[email protected]>
1 parent 56340c5 commit 057a349

File tree

7 files changed

+14
-10
lines changed

7 files changed

+14
-10
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.vscode
2+
scripts/*
3+
!scripts/k3s-cloud-start.sh
4+
!scripts/k3s-start.sh

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ In the case you wish to deploy the demo we assume you have done the following:
3939
```bash
4040
helm install --namespace smarter --create-namespace smarter-edge chart
4141
```
42-
- Use the helm chart on each of hte modules. Remember to use the namespace and the correct labels. The individual charts do not install on devices automatically, they require labels.
42+
- Use the helm chart on each of the modules. Remember to use the namespace and the correct labels. The individual charts do not install on devices automatically, they require labels.
4343

4444
## To setup your registered edge node from your development machine
4545
Plugin USB camera. You should be able to see the camera at `/dev/video0`.

charts/smarter-edge/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# smarter-edge
22

33
This chart deploys all the edge components and infrastructure for SMARTER including
4-
cni, dns and smarter-device-manager and creates a single lable that installs a pod for each in a node, smarter-edge=enabled.
4+
cni, dns and smarter-device-manager and creates a single label that installs a pod for each in a node, smarter-edge=enabled.
55

66

77
For more information on smarter go to https://getsmarter.io

k3s-cloud-master.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The script will create another local script that can be used to restart k3s if n
4747
The files token.\<instance name\> and kube.\<instance name\>.config contains the credentials to be use to authenticate a node (token file) or kubectl (kube.config file).
4848
*NOTE*: Is is important K3S_VERSION on client matches the server otherwise things are likely not to work
4949
The k3s-start.sh downloads a compatible k3s executable (that can replace kubectl) with the server and also creates a kubectl-\<instance name\>.sh script that emulates a kubectl with the correct credentials.
50-
The file env-<instance name>.sh create an alias for kubectl and adds the KUBECONFIG enviroment variable.
50+
The file env-\<instance name\>.sh create an alias for kubectl and adds the KUBECONFIG enviroment variable.
5151

5252
# Joining a k3s node
5353
To join an node which does not use our yocto build. Copy the kube_cloud_install-\<instance name\>.sh to the node and execute it. The script is already configured to connect to the server \<instance name\>.

k3s-edge-master.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The script will create another local script that can be used to restart k3s if n
5151
The files token.\<instance name\> and kube.\<instance name\>.config contains the credentials to be use to authenticate a node (token file) or kubectl (kube.config file).
5252
*NOTE*: Is is important K3S_VERSION on client matches the server otherwise things are likely not to work
5353
The k3s-start.sh downloads a compatible k3s executable (that can replace kubectl) with the server and also creates a kubectl-\<instance name\>.sh script that emulates a kubectl with the correct credentials.
54-
The file env-<instance name>.sh create an alias for kubectl and adds the KUBECONFIG enviroment variable.
54+
The file env-\<instance name\>.sh create an alias for kubectl and adds the KUBECONFIG enviroment variable.
5555

5656
# Joining a non-yocto k3s node
5757
To join an node which does not use our yocto build. Copy the kube_edge_install-\<instance name\>.sh to the node and execute it. The script is already configured to connect to the server \<instance name\>.

scripts/k3s-cloud-start.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
# Identification of the server, used for directories names and disambiguate tokens and KUBECONFIG files
55
SERVERNAME=${SERVERNAME:-default_cloud_smarter}
6-
# Especific port to be used at the server
6+
# Specific port to be used at the server
77
HOSTPORT=${HOSTPORT:-6443}
88
# IP that the clients will be used to connect (If on the cloud it will probably be the external IP of the server)
99
# HOSTIP
@@ -118,7 +118,7 @@ then
118118
exit 1
119119
fi
120120
fi
121-
echo "k3s_${SERVERNAME} is running, access thois instance using the credentials at this directory"
121+
echo "k3s_${SERVERNAME} is running, access this instance using the credentials at this directory"
122122
123123
exit 0
124124
EOF
@@ -193,6 +193,6 @@ EOF
193193
chmod u+x "${KUBECTL_CLOUD_INSTALL_FILE}"
194194
fi
195195

196-
echo "an useful trick is to create an alias for shell like: alias kubectl='$(pwd)/${KUBECTL_FILE}', if that is your only k3s running"
196+
echo "A useful trick is to create an alias for shell like: alias kubectl='$(pwd)/${KUBECTL_FILE}', if that is your only k3s running"
197197

198198
exit 0

scripts/k3s-start.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
# Identification of the server, used for directories names and disambiguate tokens and KUBECONFIG files
55
SERVERNAME=${SERVERNAME:-default_smarter}
6-
# Especific port to be used at the server
6+
# Specific port to be used at the server
77
HOSTPORT=${HOSTPORT:-6443}
88
# IP that the clients will be used to connect (If on the cloud it will probably be the external IP of the server)
99
# HOSTIP
@@ -121,7 +121,7 @@ then
121121
exit 1
122122
fi
123123
fi
124-
echo "k3s_${SERVERNAME} is running, access thois instance using the credentials at this directory"
124+
echo "k3s_${SERVERNAME} is running, access this instance using the credentials at this directory"
125125
126126
exit 0
127127
EOF
@@ -202,6 +202,6 @@ EOF
202202
chmod u+x "${KUBECTL_EDGE_INSTALL_FILE}"
203203
fi
204204

205-
echo "an useful trick is to create an alias for shell like: alias kubectl='$(pwd)/${KUBECTL_FILE}', if that is your only k3s running"
205+
echo "A useful trick is to create an alias for shell like: alias kubectl='$(pwd)/${KUBECTL_FILE}', if that is your only k3s running"
206206

207207
exit 0

0 commit comments

Comments
 (0)