docs: update pomerium-cli location (#2790)

This commit is contained in:
Travis Groth 2021-12-01 15:00:11 -05:00 committed by GitHub
parent cfa1621814
commit 1bfdae4e12
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 33 additions and 6 deletions

View file

@ -83,7 +83,7 @@ Pomerium utilizes a [minimal](https://github.com/GoogleContainerTools/distroless
- `:master` : which will pull an image in sync with git's [master](https://github.com/pomerium/pomerium/tree/master) branch.
```bash
docker pull pomerium/pomerium:latest
docker pull pomerium/pomerium:master
```
### Helm
@ -119,13 +119,13 @@ make
### Binaries
Official binaries can be found on our [GitHub Releases](https://github.com/pomerium/pomerium/releases) page.
Official binaries can be found on our [GitHub Releases](https://github.com/pomerium/cli/releases) page.
```shell
ARCH=[your arch]
OS=[your os]
VERSION=[desired version]
curl -L https://github.com/pomerium/pomerium/releases/download/${VERSION}/pomerium-cli-${OS}-${ARCH}.tar.gz \
curl -L https://github.com/pomerium/cli/releases/download/${VERSION}/pomerium-cli-${OS}-${ARCH}.tar.gz \
| tar -z -x
```
@ -133,7 +133,7 @@ curl -L https://github.com/pomerium/pomerium/releases/download/${VERSION}/pomeri
- Supported formats: `rpm`, `deb`
Official packages can be found on our [GitHub Releases](https://github.com/pomerium/pomerium/releases) page or from [Cloudsmith](https://cloudsmith.io/~pomerium/repos/pomerium/packages/).
Official packages can be found on our [GitHub Releases](https://github.com/pomerium/cli/releases) page or from [Cloudsmith](https://cloudsmith.io/~pomerium/repos/pomerium/packages/).
- [RPM Instructions](https://cloudsmith.io/~pomerium/repos/pomerium/setup/#formats-rpm)
- [Deb Instructions](https://cloudsmith.io/~pomerium/repos/pomerium/setup/#formats-deb)
@ -163,13 +163,35 @@ echo "deb https://dl.cloudsmith.io/public/pomerium/pomerium/deb/debian buster ma
brew tap pomerium/tap
brew install pomerium-cli
```
### Docker Image
The CLI utilizes a [minimal](https://github.com/GoogleContainerTools/distroless) [docker container](https://www.docker.com/resources/what-container). You can find the Pomerium CLI image on [dockerhub](https://hub.docker.com/r/pomerium/cli). It can be pulled in several flavors and architectures.
- `:vX.Y.Z`: which will pull the a [specific tagged release](https://github.com/pomerium/cli/tags).
```bash
$ docker run pomerium/cli:v0.1.0 --version
v0.1.0+53bfa4e
```
- `:latest`: which will pull the [most recent tagged release](https://github.com/pomerium/cli/releases).
```bash
$ docker run pomerium/cli:latest --version
v0.2.0+87e214b
```
- `:main` : which will pull an image in sync with git's [main](https://github.com/pomerium/pomerium/tree/main) branch.
```bash
docker pull pomerium/cli:main
```
### Source
```shell
git clone git@github.com:pomerium/pomerium.git
git clone git@github.com:pomerium/cli.git
cd pomerium
make build NAME=pomerium-cli
make build
./bin/pomerium-cli --help
```

View file

@ -19,6 +19,11 @@ The `signing_key_algorithm` option has been removed and will now be inferred fro
### Changed GitHub Team IDs
To improve performance, IdP directory synchronization for GitHub now uses the GraphQL API. This API returns the same information as the REST API, except that the GraphQL node IDs are different. Where we previously used the team integer ID from the REST API, we now use the team slug instead. Most policies should already use the team slug for group based rules, which should continue to work. However, if the integer ID is used it will no longer work. Update those policies to use the team slug instead.
### CLI Source and Packaging Update
`pomerium-cli` has been factored out of the core repository and now resides at <https://github.com/pomerium/cli>. If you currently install the CLI tool from [Packages](/docs/releases.md#packages-2) or [Homebrew](/docs/releases.md#homebrew), no changes should be required to your process. However, users of docker images or direct github release downloads will need to update their references.
Please see the [updated install instructions](/docs/releases.html#pomerium-cli) for additional details.
# Since 0.14.0
## Breaking