Skip to content

Commit

Permalink
Changes on the documentation to make the links on README.md work agai…
Browse files Browse the repository at this point in the history
…n to fix: apptio#22
  • Loading branch information
jdelarosaescobedo committed Apr 2, 2020
1 parent e94d111 commit c183865
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 5 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ kr8 consists of:
- [Task](https://github.com/go-task/task) - a third party Go binary for executing tasks
- Configs - A configuration directory which contains config for clusters and the components installed into those clusters

kr8 is not designed to be a tool to help you install and deploy applications. It's specifically designed to manage and maintain configuration for the cluster level services. For more information, see the [components](##components) section.
kr8 is not designed to be a tool to help you install and deploy applications. It's specifically designed to manage and maintain configuration for the cluster level services. For more information, see the [components](docs/components) section.

In order to use kr8, you'll need a configuration repository to go with this binary. See the [example](https://github.com/apptio/kr8-configs) repo for more information.

Expand Down Expand Up @@ -68,7 +68,3 @@ Fork the repo in github and send a merge request!
There are currently no tests, and the code is not very [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself).

This was (one of) Apptio's first exercise in Go, and pull requests are very welcome.




39 changes: 39 additions & 0 deletions docs/BUILDING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
#Building kr8

As mentioned before, kr8 is coded in [Golang](https://golang.org/) so after following the next steps you should be able to use the kr8 binary like this:

`./kr8 --help`

##Prerequisites

1. Install and configure Go: https://golang.org/doc/install

2. Get familiar with Golang: https://golang.org/doc/

3. If you are fully testing the build you need to install: https://github.com/go-task/task

----

##Building the executable

On the project root:

`go build`

Go will start downloading the dependencies to create the executable, then you will end up with the following file:

`-rwxr-xr-x 1 myuser mygroup 23M Apr 2 12:44 kr8`

Where "23M" is the current size of the executable.

##Troubleshooting the process

1. Dependencies download fail:
There is a big number of reasons this could fail but the most important might be:
-Networking problems: Check your connection to: github.com, golang.org and k8s.io.
-Disk space: If no space is available on the disk, this step might fail.

2. go build does not start the build:
Confirm you are in the correct project directory.

----

0 comments on commit c183865

Please # to comment.