Skip to content

Commit

Permalink
Merge pull request #19 from fgschwan/master
Browse files Browse the repository at this point in the history
documentation enhancements
  • Loading branch information
jozef-slezak committed Oct 12, 2017
2 parents eb9cda5 + 6f449a6 commit a872045
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ make run-examples
The command pulls needed docker images from [Dockerhub](https://hub.docker.com/r/ligato/gobgp-for-rr/),
setups networking, builds the examples, runs them, validates their output and cleans after them.

You can check in the command output the most basic test, the [gobgp_watch_plugin](https://github.com/fgschwan/bgp-agent/tree/master/examples/gobgp_watch_plugin).
You can check in the command output the most basic test, the [gobgp_watch_plugin](https://github.com/ligato/bgp-agent/tree/master/examples/gobgp_watch_plugin).

## Documentation
GoDoc can be browsed [online](https://godoc.org/github.com/ligato/bgp-agent).
Expand Down
3 changes: 2 additions & 1 deletion docker/gobgp_route_reflector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ The GoBGP Route reflector docker image is [basic golang docker image](https://hu
The Route reflector image is used in [tests](https://github.com/ligato/bgp-agent/tree/master/examples/gobgp_watch_plugin) that are running automatically or manual.
Predefined GoBGP configuration for docker container used in test can be found [here](https://github.com/ligato/bgp-agent/blob/master/docker/gobgp_route_reflector/usage_scripts/gobgp-client-in-host/gobgp.conf).

This folder also contains some helper scripts:
This folder also contains some helper scripts. These scripts are meant to run without `sudo` command, therefore the environment for docker must be [altered accordingly](https://docs.docker.com/engine/installation/linux/linux-postinstall/#manage-docker-as-a-non-root-user).

##### Build Docker
Script builds the docker image based on DockerFile.

Expand Down
2 changes: 1 addition & 1 deletion docker/gobgp_route_reflector/usage_scripts/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Usage scripts for GoBGP Route reflector docker

The purpose of the scripts is to simplify work with GoBGP Route reflector docker image/container.
The purpose of the scripts is to simplify work with GoBGP Route reflector docker image/container. These scripts are meant to run without `sudo` command, therefore the environment for docker must be [altered accordingly](https://docs.docker.com/engine/installation/linux/linux-postinstall/#manage-docker-as-a-non-root-user).

##### Create new docker network
Script creates new network that should be used by docker containers. The purpose of the network is to have more control over networking of docker containers. Default docker network i.e. doesn't allow to assing statis IP addresses to starting containers.
Expand Down

0 comments on commit a872045

Please sign in to comment.