Skip to content

Commit

Permalink
add build section to index server README. (#176)
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Valdron <[email protected]>
  • Loading branch information
michael-valdron authored Jul 10, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent bdfb830 commit 65033fd
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions index/server/README.md
Original file line number Diff line number Diff line change
@@ -6,6 +6,40 @@ Provides REST API support for devfile registries and serves [devfile registry vi

For more information on REST API docs: [registry-REST-API.adoc](registry-REST-API.adoc)

## Build

The registry index server is built into a container image, `devfile-index-base:latest`, by running the following script:

```sh
bash index/server/build.sh
```

You retag it with one of the two command:

**Docker CLI**

```sh
docker tag devfile-index-base:latest <new-image-tag>
```

**Podman CLI**

```sh
podman tag devfile-index-base:latest <new-image-tag>
```

Push your image into the an image repository with the following:

```sh
bash index/server/push.sh <new-image-tag>
```

For example, if the image repository is quay.io then use the pattern `quay.io/<user>/devfile-index-base`:

```sh
bash index/server/push.sh quay.io/someuser/devfile-index-base
```

## Testing

Endpoint unit testing is defined under `pkg/server/endpoint_test.go` and can be performed by running the following:

0 comments on commit 65033fd

Please sign in to comment.