diff --git a/.gitignore b/.gitignore index ac32c2c5d..5f3b01c3a 100644 --- a/.gitignore +++ b/.gitignore @@ -3,7 +3,7 @@ # # Ignore compiled files -kapp +kedge # # GO SPECIFIC diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1959a1b73..62ade9315 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. @@ -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! @@ -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): @@ -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 diff --git a/Makefile b/Makefile index 517d1fbb4..2109aaab5 100644 --- a/Makefile +++ b/Makefile @@ -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 @@ -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 diff --git a/README.md b/README.md index a0d6e5c1b..e85e2f92f 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 ``` @@ -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 diff --git a/ROADMAP.md b/ROADMAP.md index 72e31d57d..79d78d5e9 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -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 diff --git a/cmd/deploy.go b/cmd/deploy.go index 1bb681c71..0e0346fb3 100644 --- a/cmd/deploy.go +++ b/cmd/deploy.go @@ -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 diff --git a/cmd/generate.go b/cmd/generate.go index 021f98e1e..81dc3de16 100644 --- a/cmd/generate.go +++ b/cmd/generate.go @@ -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 ( diff --git a/cmd/root.go b/cmd/root.go index 908c2fbc4..3bd7d4d48 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -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) { diff --git a/docs/development.md b/docs/development.md index 13e764ba6..ed6f89b08 100644 --- a/docs/development.md +++ b/docs/development.md @@ -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 @@ -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 @@ -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 diff --git a/docs/file-reference.md b/docs/file-reference.md index a6744786f..6aeda5949 100644 --- a/docs/file-reference.md +++ b/docs/file-reference.md @@ -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 diff --git a/examples/allnomagic/README.md b/examples/allnomagic/README.md index 0e59dcc20..c18801bb3 100644 --- a/examples/allnomagic/README.md +++ b/examples/allnomagic/README.md @@ -1,6 +1,6 @@ # 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 @@ -8,6 +8,6 @@ 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 - ``` diff --git a/examples/health/README.md b/examples/health/README.md index 88001cc94..2dc3b98da 100644 --- a/examples/health/README.md +++ b/examples/health/README.md @@ -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: diff --git a/glide.yaml b/glide.yaml index 948bdc3cd..7953096a3 100644 --- a/glide.yaml +++ b/glide.yaml @@ -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 diff --git a/main.go b/main.go index 3f5c25090..a0453bba3 100644 --- a/main.go +++ b/main.go @@ -1,6 +1,6 @@ package main -import "github.com/surajssd/kapp/cmd" +import "github.com/kedgeproject/kedge/cmd" func main() { cmd.Execute() diff --git a/pkg/cmd/deploy.go b/pkg/cmd/deploy.go index a22fbea08..27e641988 100644 --- a/pkg/cmd/deploy.go +++ b/pkg/cmd/deploy.go @@ -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" diff --git a/pkg/cmd/generate.go b/pkg/cmd/generate.go index 7ec78865c..089d10b79 100644 --- a/pkg/cmd/generate.go +++ b/pkg/cmd/generate.go @@ -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" diff --git a/pkg/encoding/encoding.go b/pkg/encoding/encoding.go index 91a7a807b..600c625dc 100644 --- a/pkg/encoding/encoding.go +++ b/pkg/encoding/encoding.go @@ -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) { diff --git a/pkg/encoding/encoding_test.go b/pkg/encoding/encoding_test.go index 338320557..7e0ecad89 100644 --- a/pkg/encoding/encoding_test.go +++ b/pkg/encoding/encoding_test.go @@ -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" diff --git a/pkg/encoding/fix.go b/pkg/encoding/fix.go index 1d822f47a..55d59c16f 100644 --- a/pkg/encoding/fix.go +++ b/pkg/encoding/fix.go @@ -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 { diff --git a/pkg/encoding/fixtures/multiple_ports_no_names_app.go b/pkg/encoding/fixtures/multiple_ports_no_names_app.go index 1af4763de..d4c6b4cd1 100644 --- a/pkg/encoding/fixtures/multiple_ports_no_names_app.go +++ b/pkg/encoding/fixtures/multiple_ports_no_names_app.go @@ -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" ) diff --git a/pkg/encoding/fixtures/multiple_ports_some_with_names_some_without_app.go b/pkg/encoding/fixtures/multiple_ports_some_with_names_some_without_app.go index 66c7d900f..eaea0395d 100644 --- a/pkg/encoding/fixtures/multiple_ports_some_with_names_some_without_app.go +++ b/pkg/encoding/fixtures/multiple_ports_some_with_names_some_without_app.go @@ -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" ) diff --git a/pkg/encoding/fixtures/multiple_ports_with_names_app.go b/pkg/encoding/fixtures/multiple_ports_with_names_app.go index 365cd1495..32d2f3654 100644 --- a/pkg/encoding/fixtures/multiple_ports_with_names_app.go +++ b/pkg/encoding/fixtures/multiple_ports_with_names_app.go @@ -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" ) diff --git a/pkg/encoding/fixtures/single_container_app.go b/pkg/encoding/fixtures/single_container_app.go index 6a0e89738..285da8601 100644 --- a/pkg/encoding/fixtures/single_container_app.go +++ b/pkg/encoding/fixtures/single_container_app.go @@ -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" ) diff --git a/pkg/encoding/fixtures/single_persistent_volume_app.go b/pkg/encoding/fixtures/single_persistent_volume_app.go index 0c15fe88c..60899bb1a 100644 --- a/pkg/encoding/fixtures/single_persistent_volume_app.go +++ b/pkg/encoding/fixtures/single_persistent_volume_app.go @@ -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" ) diff --git a/pkg/encoding/fixtures/single_port_without_name_app.go b/pkg/encoding/fixtures/single_port_without_name_app.go index 9cde6324c..97d1932c0 100644 --- a/pkg/encoding/fixtures/single_port_without_name_app.go +++ b/pkg/encoding/fixtures/single_port_without_name_app.go @@ -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" ) diff --git a/pkg/transform/kubernetes/kubernetes.go b/pkg/transform/kubernetes/kubernetes.go index 767f47960..6bffd7e80 100644 --- a/pkg/transform/kubernetes/kubernetes.go +++ b/pkg/transform/kubernetes/kubernetes.go @@ -8,7 +8,7 @@ import ( "github.com/davecgh/go-spew/spew" "github.com/pkg/errors" - "github.com/surajssd/kapp/pkg/spec" + "github.com/kedgeproject/kedge/pkg/spec" "k8s.io/client-go/pkg/api" "k8s.io/client-go/pkg/api/resource" "k8s.io/client-go/pkg/runtime" diff --git a/pkg/transform/kubernetes/kubernetes_test.go b/pkg/transform/kubernetes/kubernetes_test.go index 7d47ebba4..5e8e70373 100644 --- a/pkg/transform/kubernetes/kubernetes_test.go +++ b/pkg/transform/kubernetes/kubernetes_test.go @@ -5,9 +5,9 @@ import ( "reflect" - encodingFixtures "github.com/surajssd/kapp/pkg/encoding/fixtures" - "github.com/surajssd/kapp/pkg/spec" - transformFixtures "github.com/surajssd/kapp/pkg/transform/fixtures" + encodingFixtures "github.com/kedgeproject/kedge/pkg/encoding/fixtures" + "github.com/kedgeproject/kedge/pkg/spec" + transformFixtures "github.com/kedgeproject/kedge/pkg/transform/fixtures" "k8s.io/client-go/pkg/runtime" ) diff --git a/scripts/check-vendor.sh b/scripts/check-vendor.sh index 63c795b6a..ca5ca7645 100755 --- a/scripts/check-vendor.sh +++ b/scripts/check-vendor.sh @@ -1,6 +1,6 @@ #!/bin/bash -# Check if there are nested vendor dirs inside kapp vendor. +# Check if there are nested vendor dirs inside kedge vendor. # All dependencies should be flattened and there shouldn't be vendor in inside vendor. function check_nested_vendor() {