Skip to content

Commit bf42bc3

Browse files
authored
Update README.md
1 parent 91e6402 commit bf42bc3

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

README.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,31 +58,51 @@ A self-service engineering platform, <a href="https://meshery.io">Meshery</a>, i
5858
<br />Try Meshery in the <a href="https://play.meshery.io">Cloud Native Playground</a> (<a href="https://youtu.be/Do7htKrRzDA">teaser video</a>)
5959
</div>
6060

61-
# kubectl meshsync snapshot
61+
## User Guide
6262

6363
A `kubectl` plugin for performing an ad hoc collection of resource information from a Kubernetes cluster and sending the cluster resources details to a Meshery Server. `kubectl meshsync snapshot` is a native kubectl plugin for conveniently synchronizing the state of your cluster with Meshery Server.
6464

65-
# Install from release
65+
66+
#### Prerequisites
67+
1) Ensure that both [kubectl](https://kubernetes.io/docs/tasks/tools/) and [krew]([url](https://krew.sigs.k8s.io/docs/user-guide/setup/install/)) are installed in your system.
68+
2) Install the `meshsync snapshot` krew plugin.
69+
6670
```sh
67-
make install
71+
kubectl krew install meshsync https://github.com/meshery-extensions/kubectl-meshsync-snapshot
72+
```
73+
74+
## Contributor Guide
75+
76+
1) Fork and clone this repo
77+
```sh
78+
git clone https://github.com/meshery-extensions/kubectl-meshsync-snapshot
6879
```
6980

70-
# Install from local
71-
1) Build
81+
2) Build project
82+
7283
```sh
7384
make build
7485
```
7586

76-
2) Update sha256
77-
Hash is produced by step 1)
78-
manually update in meshsync-snapshot-local.yaml
79-
replace <put your hash here> with hash generated by build command (step 1)
87+
2) Update sha256
88+
1. Open `meshsync-snapshot-local.yaml`.
89+
2. Using the hash produced in step 1, replace the `<put your hash here>`
90+
with hash generated by `make build`.
91+
92+
4) Install development build
8093

81-
3) Install
8294
```sh
8395
make install-local
8496
```
8597

98+
### Testing a Release
99+
100+
1) Install a released version of this extension
101+
102+
```sh
103+
make install
104+
```
105+
86106
## About Meshery Extensions
87107

88108
[Meshery Extensions](https://meshery.io/extension) are plugins or add-ons that enhance the functionality of the Meshery platform beyond its core capabilities. Meshery supports different types of extensions ([docs](https://docs.meshery.io/extensions/)):

0 commit comments

Comments
 (0)