Skip to content

Commit b497192

Browse files
authored
re-introduce install instructions with to releases (#1649)
Installation instructions were included with releases until 0.16.0, but lost after that, perhaps with release automation moving to GitHub. These instructions are still referenced in the README.md as being available in Releases, so this PR reintroduces them. **Description of the change** Re-introduces installation instructions in Releases, as referenced by README.md **Benefits** Maintain consistency with README instructions **Possible drawbacks** Splitting the instructions across multiple locations. It may be preferred to move them to README.md, but automation will be required to keep version numbers consistent. **Applicable issues** <!-- Enter any applicable Issues here (You can reference an issue using #) --> - fixes #1648 **Additional information** Install instructions were taken from those previously present in Releases, as well as from existing README instructions for client installs. There may be additional client installs or a change to the preferred controller installation method which hasn't been considered here. Signed-off-by: Anthony Goddard <[email protected]>
1 parent 46e1372 commit b497192

File tree

1 file changed

+64
-2
lines changed

1 file changed

+64
-2
lines changed

.goreleaser.yml

+64-2
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,73 @@ release:
5858
5959
New v{{ .Version }} release!
6060
footer: |
61-
## Release Notes
61+
## Installation Instructions
62+
63+
### Cluster-side
64+
65+
Install the SealedSecret CRD and server-side controller into the `kube-system` namespace:
66+
67+
```sh
68+
kubectl apply -f https://github.com/bitnami-labs/sealed-secrets/releases/download/v{{ .Version }}/controller.yaml
69+
```
70+
71+
### Client-side
72+
73+
Install the client-side tool into `/usr/local/bin/`:
74+
75+
**Linux x86_64:**
76+
```sh
77+
curl -OL "https://github.com/bitnami-labs/sealed-secrets/releases/download/v{{ .Version }}/kubeseal-{{ .Version }}-linux-amd64.tar.gz"
78+
tar -xvzf kubeseal-{{ .Version }}-linux-amd64.tar.gz kubeseal
79+
sudo install -m 755 kubeseal /usr/local/bin/kubeseal
80+
```
81+
82+
**macOS:**
83+
The `kubeseal` client is available on [homebrew](https://formulae.brew.sh/formula/kubeseal):
84+
85+
```sh
86+
brew install kubeseal
87+
```
88+
89+
**MacPorts:**
90+
91+
The `kubeseal` client is available on [MacPorts](https://ports.macports.org/port/kubeseal/summary):
92+
93+
```sh
94+
port install kubeseal
95+
```
6296
63-
Please read the [RELEASE_NOTES](https://github.com/bitnami-labs/sealed-secrets/blob/main/RELEASE-NOTES.md) which contain among other things important information for who is upgrading from previous releases.
97+
#### Nixpkgs
6498
99+
The `kubeseal` client is available on [Nixpkgs](https://search.nixos.org/packages?channel=unstable&show=kubeseal&from=0&size=50&sort=relevance&type=packages&query=kubeseal): (**DISCLAIMER**: Not maintained by bitnami-labs)
100+
101+
```sh
102+
nix-env -iA nixpkgs.kubeseal
103+
```
104+
105+
**Other OS/Arch:**
106+
Binaries for other OS/arch combinations are attached to this release below.
107+
108+
If you just want the latest client tool, it can be installed into
109+
`$GOPATH/bin` with:
110+
111+
```sh
112+
go install github.com/bitnami-labs/sealed-secrets/cmd/kubeseal@main
113+
```
114+
115+
You can specify a release tag or a commit SHA instead of `main`.
116+
117+
The `go install` command will place the `kubeseal` binary at `$GOPATH/bin`:
118+
119+
```sh
120+
$(go env GOPATH)/bin/kubeseal
121+
```
122+
123+
## Release Notes
124+
125+
Please read the [RELEASE_NOTES](https://github.com/bitnami-labs/sealed-secrets/blob/main/RELEASE-NOTES.md) which contain among other things important information for those upgrading from previous releases.
65126
## Thanks!
127+
66128
extra_files:
67129
- glob: ./controller.yaml
68130
- glob: ./controller-norbac.yaml

0 commit comments

Comments
 (0)