Skip to content

Commit

Permalink
replace markdown console w/ shell
Browse files Browse the repository at this point in the history
  • Loading branch information
Travis Clarke committed Dec 7, 2019
1 parent 692161a commit 6e0ef34
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 38 deletions.
16 changes: 8 additions & 8 deletions authentikos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,29 @@

Install using Golang:

```console
$ GO111MODULE="on" go get -u istio.io/test-infra/authentikos
```shell
GO111MODULE="on" go get -u istio.io/test-infra/authentikos
```

Install using Docker:

```console
$ docker pull gcr.io/istio-testing/authentikos:latest
```shell
docker pull gcr.io/istio-testing/authentikos:latest
```

## Usage

Run using Golang:
> Ensure `$GOPATH/bin` is on your `$PATH`; or execute `$GOPATH/bin/authentikos` directly.
```console
$ authentikos <options>
```shell
authentikos <options>
```

Run using Docker:

```console
$ docker run gcr.io/istio-testing/authentikos:latest <options>
```shell
docker run gcr.io/istio-testing/authentikos:latest <options>
```

The following is a list of supported options for `authentikos`:
Expand Down
60 changes: 30 additions & 30 deletions prow/genjobs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,37 +8,37 @@

Install using Golang:

```console
$ GO111MODULE="on" go get -u istio.io/test-infra/prow/genjobs
```shell
GO111MODULE="on" go get -u istio.io/test-infra/prow/genjobs
```

Install using Docker:

```console
$ docker pull gcr.io/istio-testing/genjobs:latest
```shell
docker pull gcr.io/istio-testing/genjobs:latest
```

Install from source:

```console
$ git clone --depth=1 https://github.com/istio/test-infra.git
$ cd ./test-infra/prow/genjobs/
$ go install
```shell
git clone --depth=1 https://github.com/istio/test-infra.git
cd ./test-infra/prow/genjobs/
go install
```

## Usage

Run using Golang:
> Ensure `$GOPATH/bin` is on your `$PATH`; or execute `$GOPATH/bin/genjobs` directly.
```console
$ genjobs <options>
```shell
genjobs <options>
```

Run using Docker:

```console
$ docker run gcr.io/istio-testing/genjobs:latest <options>
```shell
docker run gcr.io/istio-testing/genjobs:latest <options>
```

The following is a list of supported options for `genjobs`. The only **required** option is `-m, --mapping`, which is the translation mapping between public/private Github organizations.
Expand Down Expand Up @@ -76,56 +76,56 @@ The following is a list of supported options for `genjobs`. The only **required*

Translate all public jobs with `istio` organization to private jobs with `istio-private` organization in `./jobs` directory:

```console
$ genjobs --mapping istio=istio-private --input ./jobs --output ./jobs
```shell
genjobs --mapping istio=istio-private --input ./jobs --output ./jobs
```

Limit job generation to *specific* branches:

```console
$ genjobs --mapping istio=istio-private --branches master
```shell
genjobs --mapping istio=istio-private --branches master
```

Limit job generation to *specific* repositories:

```console
$ genjobs --mapping istio=istio-private --repo-whitelist cni, api
```shell
genjobs --mapping istio=istio-private --repo-whitelist cni, api
```

Limit job generation to *specific* job names:

```console
$ genjobs --mapping istio=istio-private --job-whitelist build_bots_postsubmit
```shell
genjobs --mapping istio=istio-private --job-whitelist build_bots_postsubmit
```

Define the `bucket` to upload job results to:

```console
$ genjobs --mapping istio=istio-private --bucket istio-private-build
```shell
genjobs --mapping istio=istio-private --bucket istio-private-build
```

Define the `ssh-key-secret` secret to authorize repository clone with:

```console
$ genjobs --mapping istio=istio-private --ssh-key-secret ssh-key-secret
```shell
genjobs --mapping istio=istio-private --ssh-key-secret ssh-key-secret
```

Add additional `labels` to the job:

```console
$ genjobs --mapping istio=istio-private --labels preset-service-account=true
```shell
genjobs --mapping istio=istio-private --labels preset-service-account=true
```

Set the `cluster` on which the jobs will run:

```console
$ genjobs --mapping istio=istio-private --cluster private
```shell
genjobs --mapping istio=istio-private --cluster private
```

Delete jobs in destination path prior to generation:

```console
$ genjobs --mapping istio=istio-private --clean
```shell
genjobs --mapping istio=istio-private --clean
```

## Changelog
Expand Down

0 comments on commit 6e0ef34

Please sign in to comment.