Skip to content
This repository was archived by the owner on Jun 28, 2022. It is now read-only.

Commit 67fdca5

Browse files
committed
Update README
Signed-off-by: Nick Young <ynick@vmware.com>
1 parent f2e0086 commit 67fdca5

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
11
# ir2proxy [![Build Status](https://travis-ci.com/projectcontour/ir2proxy.svg?branch=master)](https://travis-ci.com/projectcontour/ir2proxy) [![Go Report Card](https://goreportcard.com/badge/github.com/projectcontour/ir2proxy)](https://goreportcard.com/report/github.com/projectcontour/ir2proxy) ![GitHub release](https://img.shields.io/github/release/projectcontour/ir2proxy.svg) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
22

33
ir2proxy is a tool to convert ir2proxy's IngressRoute resources to HTTPProxy resources.
4+
5+
## Usage
6+
7+
`ir2proxy` is intended for taking a yaml file containing one or more valid IngressRoute objects, and then outputting translated HTTPProxy objects to stdout.
8+
9+
Logging is done to stderr.
10+
11+
To use the tool, just run it with a filename as input.
12+
13+
```sh
14+
$ ir2proxy basic.ingressroute.yaml
15+
---
16+
apiVersion: projectcontour.io/v1
17+
kind: HTTPProxy
18+
metadata:
19+
name: basic
20+
namespace: default
21+
spec:
22+
routes:
23+
- conditions:
24+
- prefix: /
25+
services:
26+
- name: s1
27+
port: 80
28+
virtualhost:
29+
fqdn: foo-basic.bar.com
30+
status:
31+
currentStatus: ""
32+
description: ""
33+
```
34+
35+
## Installation
36+
37+
Go to the [releases](https://github.com/projectcontour/ir2proxy/releases) page and download the latest version.

0 commit comments

Comments
 (0)