Skip to content
This repository has been archived by the owner on Nov 15, 2022. It is now read-only.

Commit

Permalink
docs(routes): indent the routes example in README
Browse files Browse the repository at this point in the history
Right now the way routes example is explained in it's README, it is
not very helpful and can confuse user, so placing it in right
indentation.
  • Loading branch information
surajssd committed Nov 21, 2017
1 parent 0709fa1 commit 1240e55
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions docs/examples/routes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,34 @@ to define OpenShift routes.

An OpenShift route is a way to expose a service by giving it an
externally-reachable hostname.
More info at https://docs.openshift.com/enterprise/3.0/architecture/core_concepts/routes.html
More info about routes can be found [here](https://docs.openshift.com/enterprise/3.0/architecture/core_concepts/routes.html)

Much like other resource definitions in Kedge, routes have been implemented
by merging `RouteSpec` and `ObjectMeta`, which would mean that you can
define fields like `name` and the rest of the RouteSpec at the same level.

An example would be -
A snippet from [httpd.yml](httpd.yml):

```yaml
...
routes:
- to:
kind: Service
name: httpd
```

A more detailed example might look like this:

```yaml
name: webroute
host: httpd-web.192.168.42.69.nip.io
to:
kind: Service
name: httpd
weight: 100
wildcardPolicy: None
...
routes:
- name: webroute
host: httpd-web.192.168.42.69.nip.io
to:
kind: Service
name: httpd
weight: 100
wildcardPolicy: None
```

## Ref
Expand Down

0 comments on commit 1240e55

Please sign in to comment.