Skip to content

Commit 8571fc9

Browse files
authored
chore: update docs (#210)
1 parent e5bfd80 commit 8571fc9

1 file changed

Lines changed: 23 additions & 17 deletions

File tree

README.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Insomnia Mockbin is maintained by [Kong](https://github.com/Kong), who also main
3131
- allows for HTTP Method Override using the header `X-HTTP-Method-Override` or through query string parameter: `_method`
3232
- create custom bins for experimenting log collection
3333

34-
## Installation
34+
## Local Development
3535

3636
### Requirements
3737

@@ -66,28 +66,34 @@ npm run dev
6666
DEBUG=mockbin npm run dev
6767
```
6868

69-
## Running with Docker Compose
69+
### Running with Docker Compose
7070

7171
```shell
7272
docker compose up
7373
```
7474

75-
## Documentation
76-
77-
### API Docs
78-
79-
Read the full API documentation, please review the [API Docs](https://github.com/Kong/mockbin/tree/master/docs).
80-
81-
## Releasing
75+
### Releasing
8276

8377
Run the following command and push the newly created commit into your PR.
8478
This will bump commit and tag, you will need to push this to the remote, which trigger the release action upon merging the PR.
8579

80+
Please note that separate branches are currently maintained for cloud mocks and self hosted mocks. Merging to the default branch or creating a tag on a commit on the default branch will result in the cloud mock server image being published. Merging to the `self-hosted` branch of creating a tag on a commit on the `self-hosted` branch (please use the format v.x.x.x-self-hosted in this case) will result in the self-hosted mock server image being published.
81+
8682
```sh
8783
npm version patch
8884
git push origin tag <tag_name>
8985
```
9086

87+
## Documentation
88+
89+
### API Docs
90+
91+
Read the full API documentation, please review the [API Docs](https://github.com/Kong/mockbin/tree/master/docs).
92+
93+
### Deployment
94+
95+
See [https://developer.konghq.com/insomnia/mock-servers/](https://developer.konghq.com/insomnia/mock-servers/) for the available options for deploying mockbin.
96+
9197
### Software Bill of materials
9298

9399
Kong Insomnia Mockbin produces SBOMs for the below categories:
@@ -102,15 +108,15 @@ The SBOMs are available to download at:
102108

103109
### Verify a container image signature
104110

105-
Docker container images are now signed using cosign with signatures published to a [Github Container registry](https://ghcr.io) with `insomnia-mockbin` repository.
111+
Docker container images are now signed using cosign with signatures published to a [Github Container registry](https://ghcr.io) with `insomnia-mockbin` repository. Separate images are published for cloud hosted mocks ([ghcr.io/kong/insomnia-mockbin-cloud](https://developer.konghq.com/how-to/create-a-cloud-hosted-mock-server/)) and self-hosted mocks ([ghcr.io/kong/insomnia-mockbin-self-hosted](https://developer.konghq.com/insomnia/self-hosted-mocks/)). Modify the examples below if you need to verify the image for self-hosted mocks.
106112

107113
Steps to verify signatures for signed Kong Insomnia Mockbin Docker container images in two different ways:
108114

109115
A minimal example, used to verify an image without leveraging any annotations. For the minimal example, you only need Docker details, a GitHub repo name, and a GitHub workflow filename.
110116

111117
```code
112118
cosign verify \
113-
ghcr.io/kong/insomnia-mockbin:<tag>@sha256:<digest> \
119+
ghcr.io/kong/insomnia-mockbin-cloud:<tag>@sha256:<digest> \
114120
--certificate-oidc-issuer='https://token.actions.githubusercontent.com' \
115121
--certificate-identity-regexp='https://github.com/Kong/insomnia-mockbin/.github/workflows/release.yaml'
116122
```
@@ -119,7 +125,7 @@ A complete example, leveraging optional annotations for increased trust. For the
119125

120126
```code
121127
cosign verify \
122-
ghcr.io/kong/insomnia-mockbin:<tag>@sha256:<digest> \
128+
ghcr.io/kong/insomnia-mockbin-cloud:<tag>@sha256:<digest> \
123129
--certificate-oidc-issuer='https://token.actions.githubusercontent.com' \
124130
--certificate-identity-regexp='https://github.com/Kong/insomnia-mockbin/.github/workflows/release.yaml' \
125131
-a repo='Kong/insomnia-mockbin' \
@@ -135,22 +141,22 @@ Steps to verify provenance for signed Kong Insomnia Mockbin Docker container ima
135141
1. Fetch the image `<manifest_digest>` using regctl:
136142

137143
```code
138-
regctl image digest ghcr.io/kong/insomnia-mockbin:<tag>
144+
regctl image digest ghcr.io/kong/insomnia-mockbin-cloud:<tag>
139145
```
140146
141147
2. A minimal example, used to verify an image without leveraging any annotations. For the minimal example, you only need Docker Image manifest, a GitHub repo name.
142148
143149
```code
144150
cosign verify-attestation \
145-
ghcr.io/kong/insomnia-mockbin:<tag>@sha256:<manifest_digest> \
151+
ghcr.io/kong/insomnia-mockbin-cloud:<tag>@sha256:<manifest_digest> \
146152
--type='slsaprovenance' \
147153
--certificate-oidc-issuer='https://token.actions.githubusercontent.com' \
148154
--certificate-identity-regexp='^https://github.com/slsa-framework/slsa-github-generator/.github/workflows/generator_container_slsa3.yml@refs/tags/v[0-9]+.[0-9]+.[0-9]+$'
149155
```
150156
151157
```code
152158
slsa-verifier verify-image \
153-
ghcr.io/kong/insomnia-mockbin:<tag>@sha256:<manifest_digest> \
159+
ghcr.io/kong/insomnia-mockbin-cloud:<tag>@sha256:<manifest_digest> \
154160
--print-provenance \
155161
--source-uri 'github.com/Kong/insomnia-mockbin'
156162
```
@@ -159,7 +165,7 @@ Steps to verify provenance for signed Kong Insomnia Mockbin Docker container ima
159165
160166
```code
161167
cosign verify-attestation \
162-
ghcr.io/kong/insomnia-mockbin:<tag>@sha256:<manifest_digest> \
168+
ghcr.io/kong/insomnia-mockbin-cloud:<tag>@sha256:<manifest_digest> \
163169
--type='slsaprovenance' \
164170
--certificate-oidc-issuer='https://token.actions.githubusercontent.com' \
165171
--certificate-identity-regexp='^https://github.com/slsa-framework/slsa-github-generator/.github/workflows/generator_container_slsa3.yml@refs/tags/v[0-9]+.[0-9]+.[0-9]+$' \
@@ -169,7 +175,7 @@ Steps to verify provenance for signed Kong Insomnia Mockbin Docker container ima
169175
170176
```code
171177
slsa-verifier verify-image \
172-
ghcr.io/kong/insomnia-mockbin:<tag>@sha256:<manifest_digest> \
178+
ghcr.io/kong/insomnia-mockbin-cloud:<tag>@sha256:<manifest_digest> \
173179
--print-provenance \
174180
--source-uri 'github.com/Kong/insomnia-mockbin' \
175181
--source-tag '<tag>'

0 commit comments

Comments
 (0)