Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc how to build, run and the usage #15

Merged
merged 1 commit into from
Mar 15, 2021
Merged

doc how to build, run and the usage #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,9 @@ After your PR is ready to commit, please run following commands to check your co
make lint
```

## Build bianry
## Build images

Make sure your code build passed.

```shell
make docker-binary
```
make docker-image
```
29 changes: 27 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Management Ingress
NGINX based ingress controller to serve Open Cluster Management services.

# annotations
## Overview
management-ingress is a NGINX based ingress controller to serve Open Cluster Management service.

## Get started
You can add below Kubernetes annotations to specific Ingress objects to customize their behavior. See the [examples](examples) to get more details of the usage.

| Name | Description | Values |
| --- | --- | --- |
Expand All @@ -21,3 +24,25 @@ NGINX based ingress controller to serve Open Cluster Management services.
| ingress.open-cluster-management.io/proxy-buffer-size | buffer size of response | string |
| ingress.open-cluster-management.io/proxy-body-size | max response body | string |
| ingress.open-cluster-management.io/connection | override connection header | string |

## Developing
### Prerequisites
- Go 1.15+
- Docker v19.03.0+
- OpenShift 3.11+

### Build the binary
```shell
make docker-binary
```

### Build the image
```shell
make docker-image
```

### Installation
Follow [management-ingress-chart](https://github.com/open-cluster-management/management-ingress-chart) documentation to install management ingress in your OpenShift cluster, and replace the deployment `management-ingress` image name with your own.

## Contributing
* See [CONTRIBUTING.md](CONTRIBUTING.md) for information about the workflow that we expect, and instructions on the developer certificate of origin that we require.