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

kapp -> kedge #90

Merged
merged 1 commit into from
Jun 28, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#

# Ignore compiled files
kapp
kedge

#
# GO SPECIFIC
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines (not rules) for contributing to Kapp.
The following is a set of guidelines (not rules) for contributing to Kedge.

These are just guidelines, not rules, use your best judgment and feel free to
propose changes to this document in a pull request.
Expand All @@ -17,7 +17,7 @@ Before you submit your pull request consider the following guidelines:
```

* Create your patch, **including appropriate test cases**.
* Include documentation that either describe a change to a behavior of kapp or the changed capability to an end user of kapp.
* Include documentation that either describe a change to a behavior of kedge or the changed capability to an end user of kedge.
* Commit your changes using **a descriptive commit message**. If you are fixing an issue please include something like 'this closes issue #xyz'.
* Make sure your tests pass!

Expand All @@ -31,7 +31,7 @@ Before you submit your pull request consider the following guidelines:
git push origin bug/my-fix-branch
```

* In GitHub, send a pull request to `kapp:master`.
* In GitHub, send a pull request to `kedge:master`.
* If we suggest changes then:
* Make the required updates.
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
Expand All @@ -47,7 +47,7 @@ That's it! Thank you for your contribution!

* Include unit or integration tests for the capability you have implemented
* Include documentation for the capability you have implemented
* If you are fixing an issue within Kapp, include the issue number you are fixing
* If you are fixing an issue within Kedge, include the issue number you are fixing

### After your pull request is merged

Expand Down
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@


GITCOMMIT := $(shell git rev-parse --short HEAD)
BUILD_FLAGS := -ldflags="-w -X github.com/surajssd/kapp/cmd.GITCOMMIT=$(GITCOMMIT)"
BUILD_FLAGS := -ldflags="-w -X github.com/kedgeproject/kedge/cmd.GITCOMMIT=$(GITCOMMIT)"
PKGS = $(shell glide novendor)

default: bin
Expand All @@ -11,20 +11,20 @@ all: bin

.PHONY: bin
bin:
go build ${BUILD_FLAGS} -o kapp main.go
go build ${BUILD_FLAGS} -o kedge main.go

.PHONY: install
install:
go install ${BUILD_FLAGS}

# kompile kapp for multiple platforms
# kompile kedge for multiple platforms
.PHONY: cross
cross:
gox -osarch="darwin/amd64 linux/amd64 linux/arm windows/amd64" -output="bin/kapp-{{.OS}}-{{.Arch}}" $(BUILD_FLAGS)
gox -osarch="darwin/amd64 linux/amd64 linux/arm windows/amd64" -output="bin/kedge-{{.OS}}-{{.Arch}}" $(BUILD_FLAGS)

.PHONY: clean
clean:
rm -f kapp
rm -f kedge
rm -r -f bundles

# run all validation tests
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
# Kapp - Openly Compose Applications for Kubernetes
# Kedge - Openly Compose Applications for Kubernetes

## What is Kapp?
## What is Kedge?

Kapp is a CLI tool for deploying simple high-abstracted YAML files to container orchestrators such as Kubernetes.
Kedge is a CLI tool for deploying simple high-abstracted YAML files to container orchestrators such as Kubernetes.

Key features and goals include:

- _Simplicity:_ Using a simple, high-abstracted specification that is easy to understand and define.
- _Multi-container environments:_ Define your containers, services and applications in one simple file, or abstract into multiple files.
- _Familiar structure:_ Using a familiar YAML structure as Kubernetes, it's easy to pick-up and understand Kapp.
- _No need to define everything:_ Define the necessary services and Kapp will do the rest. Kapp will interprolate and pick the best defaults for your application to run on Kubernetes.
- _Familiar structure:_ Using a familiar YAML structure as Kubernetes, it's easy to pick-up and understand Kedge.
- _No need to define everything:_ Define the necessary services and Kedge will do the rest. Kedge will interprolate and pick the best defaults for your application to run on Kubernetes.

## Project status

We are a very evolving project with high velocity, we have listed a [file reference specification](docs/file-reference.md) as well as document our RFC's and changes as [GitHub issues](https://github.com/surajssd/kapp/issues).
We are a very evolving project with high velocity, we have listed a [file reference specification](docs/file-reference.md) as well as document our RFC's and changes as [GitHub issues](https://github.com/kedgeproject/kedge/issues).

Check out our [roadmap](ROADMAP.md) as we push towards a __0.1.0__ release.

## Using Kapp
## Using Kedge

### Installation

The _best_ way to try Kapp is to download the most up-to-date binary from the master GitHub branch:
The _best_ way to try Kedge is to download the most up-to-date binary from the master GitHub branch:

```sh
go get github.com/surajssd/kapp
go get github.com/kedgeproject/kedge
```

### Trying it out

We have an [extensive list of examples](examples) to check out, but the simplest of them all is a [standard http example](https://raw.githubusercontent.com/surajssd/kapp/master/examples/simplest/httpd.yaml) with [minikube](https://github.com/kubernetes/minikube):
We have an [extensive list of examples](examples) to check out, but the simplest of them all is a [standard http example](https://raw.githubusercontent.com/kedgeproject/kedge/master/examples/simplest/httpd.yaml) with [minikube](https://github.com/kubernetes/minikube):

```yaml
name: httpd
Expand All @@ -46,7 +46,7 @@ services:
We can now generate and deploy this example to Kubernetes:

```sh
kapp generate -f httpd.yaml | kubectl create -f -
kedge generate -f httpd.yaml | kubectl create -f -
deployment "httpd" created
service "httpd" created
```
Expand All @@ -73,7 +73,7 @@ Our examples range from [as simple as you can get](examples/simplest) to [every

## Contributing

Kapp is an evolving project and contributions are happily welcome. Feel free to open up an issue or even a PR. Read our [contributing guide](CONTRIBUTING.md) for more details. If you're interested in submitting a patch, feel free to check our [development guide](docs/development.md) as well for ease into the project.
Kedge is an evolving project and contributions are happily welcome. Feel free to open up an issue or even a PR. Read our [contributing guide](CONTRIBUTING.md) for more details. If you're interested in submitting a patch, feel free to check our [development guide](docs/development.md) as well for ease into the project.

## License

Expand Down
6 changes: 3 additions & 3 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Kapp roadmap
# Kedge roadmap

The goal of Kapp is to have the __best__ possible experience when deploying Kubernetes artifacts.
The goal of Kedge is to have the __best__ possible experience when deploying Kubernetes artifacts.

Here we outline our goals for future releases:

## Kapp 0.1.0
## Kedge 0.1.0

* [ ] Parameterize the ingress host value or endpoint value
* [ ] Rename persistentVolumes to something better like volumeClaims
Expand Down
2 changes: 1 addition & 1 deletion cmd/deploy.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"os"

"github.com/spf13/cobra"
pkgcmd "github.com/surajssd/kapp/pkg/cmd"
pkgcmd "github.com/kedgeproject/kedge/pkg/cmd"
)

// Variables
Expand Down
2 changes: 1 addition & 1 deletion cmd/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"os"

"github.com/spf13/cobra"
pkgcmd "github.com/surajssd/kapp/pkg/cmd"
pkgcmd "github.com/kedgeproject/kedge/pkg/cmd"
)

var (
Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ var (

// RootCmd represents the base command when called without any subcommands
var RootCmd = &cobra.Command{
Use: "kapp",
Use: "kedge",
Short: "Define Kubernetes applications using Kubernetes constructs",
PersistentPreRun: func(cmd *cobra.Command, args []string) {

Expand Down
22 changes: 11 additions & 11 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Development Guide

## Building Kapp
## Building Kedge

Read about building kapp [here](https://github.com/surajssd/kapp#building).
Read about building kedge [here](https://github.com/kedgeproject/kedge#building).

## Workflow
### Fork the main repository

1. Go to https://github.com/surajssd/kapp
1. Go to https://github.com/kedgeproject/kedge
2. Click the "Fork" button (at the top right)

### Clone your fork

The commands below require that you have $GOPATH. We highly recommended you put Kapp' code into your $GOPATH.
The commands below require that you have $GOPATH. We highly recommended you put Kedge' code into your $GOPATH.

```console
git clone https://github.com/$YOUR_GITHUB_USERNAME/kapp.git $GOPATH/src/github.com/surajssd/kapp
cd $GOPATH/src/github.com/surajssd/kapp
git remote add upstream 'https://github.com/surajssd/kapp'
git clone https://github.com/$YOUR_GITHUB_USERNAME/kedge.git $GOPATH/src/github.com/kedgeproject/kedge
cd $GOPATH/src/github.com/kedgeproject/kedge
git remote add upstream 'https://github.com/kedgeproject/kedge'
```

### Create a branch and make changes
Expand All @@ -34,7 +34,7 @@ git fetch upstream
git rebase upstream/master
```

Note: If you have write access to the main repository at github.com/surajssd/kapp, you should modify your git configuration so that you can't accidentally push to upstream:
Note: If you have write access to the main repository at github.com/kedgeproject/kedge, you should modify your git configuration so that you can't accidentally push to upstream:

```console
git remote set-url --push upstream no_push
Expand All @@ -49,14 +49,14 @@ git push -f origin myfeature

### Creating a pull request

1. Visit https://github.com/$YOUR_GITHUB_USERNAME/kapp.git
1. Visit https://github.com/$YOUR_GITHUB_USERNAME/kedge.git
2. Click the "Compare and pull request" button next to your "myfeature" branch.
3. Check out the pull request process for more details

## `glide`, `glide-vc` and dependency management

Kapp uses `glide` to manage dependencies and `glide-vc` to clean vendor directory.
They are not strictly required for building Kapp but they are required when managing dependencies under the `vendor/` directory.
Kedge uses `glide` to manage dependencies and `glide-vc` to clean vendor directory.
They are not strictly required for building Kedge but they are required when managing dependencies under the `vendor/` directory.
If you want to make changes to dependencies please make sure that `glide` and `glide-vc` are installed and are in your `$PATH`.

### Installing glide
Expand Down
4 changes: 2 additions & 2 deletions docs/file-reference.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Kapp file reference
# Kedge file reference

Each file defines one micro-service, which forms one `pod` controlled by it's
controller(right now the default controller is `deployment`).


A example using all the keys added in Kapp(not all keys from Kubernetes
A example using all the keys added in Kedge(not all keys from Kubernetes
API are included):

```yaml
Expand Down
4 changes: 2 additions & 2 deletions examples/allnomagic/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# All constructs and no magic

The artifacts here are purely hand written and has use no magic provided by current implementation of kapp.
The artifacts here are purely hand written and has use no magic provided by current implementation of kedge.

## Deploy

Deploying application in this requires secrets to be created already:

```bash
oc create secret generic wordpress --from-literal='MYSQL_ROOT_PASSWORD=rootpasswd,DB_PASSWD=wordpress'
kapp generate -f web.yaml -f db.yaml | oc create -f -
kedge generate -f web.yaml -f db.yaml | oc create -f -
```

2 changes: 1 addition & 1 deletion examples/health/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ When this is expanded the same content is replicated in both
fields:

```yaml
$ kapp generate -f web.yaml
$ kedge generate -f web.yaml
...
livenessProbe:
httpGet:
Expand Down
2 changes: 1 addition & 1 deletion glide.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package: github.com/surajssd/kapp
package: github.com/kedgeproject/kedge
import:
- package: github.com/ghodss/yaml
- package: github.com/spf13/cobra
Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package main

import "github.com/surajssd/kapp/cmd"
import "github.com/kedgeproject/kedge/cmd"

func main() {
cmd.Execute()
Expand Down
4 changes: 2 additions & 2 deletions pkg/cmd/deploy.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import (
"io/ioutil"
"os/exec"

"github.com/surajssd/kapp/pkg/encoding"
"github.com/surajssd/kapp/pkg/transform/kubernetes"
"github.com/kedgeproject/kedge/pkg/encoding"
"github.com/kedgeproject/kedge/pkg/transform/kubernetes"

"github.com/ghodss/yaml"
"github.com/pkg/errors"
Expand Down
4 changes: 2 additions & 2 deletions pkg/cmd/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import (
"regexp"
"strings"

"github.com/surajssd/kapp/pkg/encoding"
"github.com/surajssd/kapp/pkg/transform/kubernetes"
"github.com/kedgeproject/kedge/pkg/encoding"
"github.com/kedgeproject/kedge/pkg/transform/kubernetes"

"github.com/ghodss/yaml"
"github.com/pkg/errors"
Expand Down
2 changes: 1 addition & 1 deletion pkg/encoding/encoding.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"github.com/ghodss/yaml"
"github.com/pkg/errors"

"github.com/surajssd/kapp/pkg/spec"
"github.com/kedgeproject/kedge/pkg/spec"
)

func Decode(data []byte) (*spec.App, error) {
Expand Down
4 changes: 2 additions & 2 deletions pkg/encoding/encoding_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package encoding
import (
"testing"

"github.com/surajssd/kapp/pkg/encoding/fixtures"
"github.com/surajssd/kapp/pkg/spec"
"github.com/kedgeproject/kedge/pkg/encoding/fixtures"
"github.com/kedgeproject/kedge/pkg/spec"

"reflect"

Expand Down
2 changes: 1 addition & 1 deletion pkg/encoding/fix.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"strconv"

"github.com/pkg/errors"
"github.com/surajssd/kapp/pkg/spec"
"github.com/kedgeproject/kedge/pkg/spec"
)

func fixApp(app *spec.App) error {
Expand Down
2 changes: 1 addition & 1 deletion pkg/encoding/fixtures/multiple_ports_no_names_app.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package fixtures

import (
"github.com/surajssd/kapp/pkg/spec"
"github.com/kedgeproject/kedge/pkg/spec"
api_v1 "k8s.io/client-go/pkg/api/v1"
)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package fixtures

import (
"github.com/surajssd/kapp/pkg/spec"
"github.com/kedgeproject/kedge/pkg/spec"
api_v1 "k8s.io/client-go/pkg/api/v1"
)

Expand Down
2 changes: 1 addition & 1 deletion pkg/encoding/fixtures/multiple_ports_with_names_app.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package fixtures

import (
"github.com/surajssd/kapp/pkg/spec"
"github.com/kedgeproject/kedge/pkg/spec"
api_v1 "k8s.io/client-go/pkg/api/v1"
)

Expand Down
2 changes: 1 addition & 1 deletion pkg/encoding/fixtures/single_container_app.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package fixtures

import (
"github.com/surajssd/kapp/pkg/spec"
"github.com/kedgeproject/kedge/pkg/spec"
api_v1 "k8s.io/client-go/pkg/api/v1"
)

Expand Down
2 changes: 1 addition & 1 deletion pkg/encoding/fixtures/single_persistent_volume_app.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package fixtures

import (
"github.com/surajssd/kapp/pkg/spec"
"github.com/kedgeproject/kedge/pkg/spec"
api_v1 "k8s.io/client-go/pkg/api/v1"
)

Expand Down
2 changes: 1 addition & 1 deletion pkg/encoding/fixtures/single_port_without_name_app.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package fixtures

import (
"github.com/surajssd/kapp/pkg/spec"
"github.com/kedgeproject/kedge/pkg/spec"
api_v1 "k8s.io/client-go/pkg/api/v1"
)

Expand Down
Loading