Skip to content

Commit

Permalink
Update pkg paths to kubedb org (#133)
Browse files Browse the repository at this point in the history
  • Loading branch information
tamalsaha authored Dec 4, 2017
1 parent 82efb63 commit 0c467fe
Show file tree
Hide file tree
Showing 119 changed files with 591 additions and 521 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
If you have found a bug with KubeDB or want to request for new features, please file issues on Github.
- For CLI issues, file a bug under [k8sdb/cli](https://github.com/k8sdb/cli) repository.
- For Backend operator issues, file a bug under [k8sdb/operator](https://github.com/k8sdb/operator) repository.
- For CLI issues, file a bug under [kubedb/cli](https://github.com/kubedb/cli) repository.
- For Backend operator issues, file a bug under [kubedb/operator](https://github.com/kubedb/operator) repository.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ If you have a question about KubeDB or having problem using it, you can contact

## Bugs/Feature request
If you have found a bug with KubeDB or want to request for new features, please file issues on Github.
- For CLI issues, file a bug under [k8sdb/cli](https://github.com/k8sdb/cli) repository.
- For Backend operator issues, file a bug under [k8sdb/operator](https://github.com/k8sdb/operator) repository.
- For CLI issues, file a bug under [kubedb/cli](https://github.com/kubedb/cli) repository.
- For Backend operator issues, file a bug under [kubedb/operator](https://github.com/kubedb/operator) repository.

## Contribution Flow
If you fix a bug or developed a new feature, feel free to submit a PR. In either case, please file a Github issue first, so that we can have a discussion on it. This is a rough outline of what a contributor's workflow looks like:
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/k8sdb/cli)](https://goreportcard.com/report/github.com/k8sdb/cli)
[![Go Report Card](https://goreportcard.com/badge/github.com/kubedb/cli)](https://goreportcard.com/report/github.com/kubedb/cli)

[Website](https://kubedb.com)[Slack](http://slack.kubernetes.io)[Twitter](https://twitter.com/KubeDB)

Expand All @@ -20,8 +20,8 @@ Please pick a version of KubeDB that matches your Kubernetes installation.

| KubeDB Version | Docs | Kubernetes Version |
|---------------------------------------------------------------------|------------------------------------------------------------|--------------------|
| [0.7.1](https://github.com/k8sdb/cli/releases/tag/0.7.1) (uses CRD) | [User Guide](https://github.com/k8sdb/cli/tree/0.7.1/docs) | 1.7.x+ |
| [0.6.0](https://github.com/k8sdb/cli/releases/tag/0.6.0) (uses TPR) | [User Guide](https://github.com/k8sdb/cli/tree/0.6.0/docs) | 1.5.x - 1.7.x |
| [0.7.1](https://github.com/kubedb/cli/releases/tag/0.7.1) (uses CRD) | [User Guide](https://github.com/kubedb/cli/tree/0.7.1/docs) | 1.7.x+ |
| [0.6.0](https://github.com/kubedb/cli/releases/tag/0.6.0) (uses TPR) | [User Guide](https://github.com/kubedb/cli/tree/0.6.0/docs) | 1.5.x - 1.7.x |

## Installation
To install KubeDB, please follow the guide [here](/docs/install.md).
Expand All @@ -45,6 +45,6 @@ Wondering what features are coming next? Please visit [here](/ROADMAP.md).
If you have any questions, talk to us on the [Kubernetes Slack team](http://slack.kubernetes.io/) channel `#kubedb`.

If you have found a bug with KubeDB or want to request for new features, please file issues on Github.
- For CLI issues, file a bug under [k8sdb/cli](https://github.com/k8sdb/cli) repository.
- For Backend operator issues, file a bug under [k8sdb/operator](https://github.com/k8sdb/operator) repository.
- For CLI issues, file a bug under [kubedb/cli](https://github.com/kubedb/cli) repository.
- For Backend operator issues, file a bug under [kubedb/operator](https://github.com/kubedb/operator) repository.

2 changes: 1 addition & 1 deletion cmd/kubedb/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package main
import (
"os"

"github.com/k8sdb/cli/pkg/cmds"
"github.com/kubedb/cli/pkg/cmds"
)

func main() {
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ aliases:
- /docs/0.7.1/README/
---

[![Go Report Card](https://goreportcard.com/badge/github.com/k8sdb/cli)](https://goreportcard.com/report/github.com/k8sdb/cli)
[![Go Report Card](https://goreportcard.com/badge/github.com/kubedb/cli)](https://goreportcard.com/report/github.com/kubedb/cli)

# KubeDB
Running production quality database in Kubernetes can be tricky to say the least. In the early days of Kubernetes, replication controllers were used to run a single pod for a database. With the introduction of StatefulSet, it became easy to run a docker container for any database. But what about monitoring, taking periodic backups, restoring from backups or cloning from an existing database? KubeDB is a framework for writing operators for any database that support the following operational requirements:
Expand All @@ -34,8 +34,8 @@ Please pick a version of KubeDB that matches your Kubernetes installation.

| KubeDB Version | Docs | Kubernetes Version |
|---------------------------------------------------------------------|------------------------------------------------------------|--------------------|
| [0.7.1](https://github.com/k8sdb/cli/releases/tag/0.7.1) (uses CRD) | [User Guide](https://github.com/k8sdb/cli/tree/0.7.1/docs) | 1.7.x+ |
| [0.6.0](https://github.com/k8sdb/cli/releases/tag/0.6.0) (uses TPR) | [User Guide](https://github.com/k8sdb/cli/tree/0.6.0/docs) | 1.5.x - 1.7.x |
| [0.7.1](https://github.com/kubedb/cli/releases/tag/0.7.1) (uses CRD) | [User Guide](https://github.com/kubedb/cli/tree/0.7.1/docs) | 1.7.x+ |
| [0.6.0](https://github.com/kubedb/cli/releases/tag/0.6.0) (uses TPR) | [User Guide](https://github.com/kubedb/cli/tree/0.6.0/docs) | 1.5.x - 1.7.x |

## Installation
To install KubeDB, please follow the guide [here](/docs/install.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ spec:
| `spec.monitor.prometheus.labels` | map | `Required`. Indicates labels applied to service monitor. |
| `spec.monitor.prometheus.interval` | string | `Optional`. Indicates the scrape interval for database exporter endpoint (eg, '10s') |

__Known Limitations:__ If the databse password is updated, exporter must be restarted to use the new credentials. This issue is tracked [here](https://github.com/k8sdb/operator/issues/63).
__Known Limitations:__ If the databse password is updated, exporter must be restarted to use the new credentials. This issue is tracked [here](https://github.com/kubedb/operator/issues/63).


## Next Steps
Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ spec:
scriptSource:
scriptPath: "postgres-init-scripts/run.sh"
gitRepo:
repository: "https://github.com/k8sdb/postgres-init-scripts.git"
repository: "https://github.com/kubedb/postgres-init-scripts.git"
backupSchedule:
cronExpression: "@every 6h"
storageSecretName: snap-secret
Expand Down Expand Up @@ -126,7 +126,7 @@ spec:
scriptSource:
scriptPath: "postgres-init-scripts/run.sh"
gitRepo:
repository: "https://github.com/k8sdb/postgres-init-scripts.git"
repository: "https://github.com/kubedb/postgres-init-scripts.git"
```

In the above example, KubeDB operator will launch a Job to execute `run.sh` script once StatefulSet pods are running.
Expand Down
18 changes: 9 additions & 9 deletions docs/developer-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,23 @@ KubeDB is written in Google's GO programming language. Currently, KubeDB is deve
development environment, please follow [these instructions](https://golang.org/doc/code.html) to install GO.

#### Code Organization
KubeDB codebase is across various repositories under github.com/k8sdb organization. There are 5 categories of git repositories:
KubeDB codebase is across various repositories under github.com/kubedb organization. There are 5 categories of git repositories:

| Repository | Description |
|---------------------------------------|---------------------------------------------------------------------------------------------------------|
| https://github.com/k8sdb/apimachinery | Contains api types, clientset and KubeDB framework interfaces. |
| https://github.com/k8sdb/db | This repository contains operator for `db`, eg, https://github.com/k8sdb/postgres |
| https://github.com/k8sdb/db_exporter | This repository contains Prometheus exporter for `db`, eg, https://github.com/k8sdb/postgres_exporter . |
| https://github.com/k8sdb/operator | This repository contains the combined operator for all databases supported by KubeDB. |
| https://github.com/k8sdb/cli | This repository contains CLI for KubeDB. |
| https://github.com/kubedb/apimachinery | Contains api types, clientset and KubeDB framework interfaces. |
| https://github.com/kubedb/db | This repository contains operator for `db`, eg, https://github.com/kubedb/postgres |
| https://github.com/kubedb/db_exporter | This repository contains Prometheus exporter for `db`, eg, https://github.com/kubedb/postgres_exporter . |
| https://github.com/kubedb/operator | This repository contains the combined operator for all databases supported by KubeDB. |
| https://github.com/kubedb/cli | This repository contains CLI for KubeDB. |

For each of these repositories, you can get source code and build code using the following steps:

#### Download Source

```console
$ go get github.com/k8sdb/operator
$ cd $(go env GOPATH)/src/github.com/k8sdb/operator
$ go get github.com/kubedb/operator
$ cd $(go env GOPATH)/src/github.com/kubedb/operator
```

#### Install Dev tools
Expand Down Expand Up @@ -85,6 +85,6 @@ $ docker push aerokite/operator:default

#### Generate CLI Reference Docs
```console
$ cd ~/go/src/github.com/k8sdb/cli
$ cd ~/go/src/github.com/kubedb/cli
$ ./hack/gendocs/make.sh
```
2 changes: 1 addition & 1 deletion docs/examples/postgres/demo-1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ spec:
scriptSource:
scriptPath: "postgres-init-scripts/run.sh"
gitRepo:
repository: "https://github.com/k8sdb/postgres-init-scripts.git"
repository: "https://github.com/kubedb/postgres-init-scripts.git"
2 changes: 1 addition & 1 deletion docs/examples/postgres/demo-3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ spec:
scriptSource:
scriptPath: "postgres-init-scripts/run.sh"
gitRepo:
repository: "https://github.com/k8sdb/postgres-init-scripts.git"
repository: "https://github.com/kubedb/postgres-init-scripts.git"
backupSchedule:
cronExpression: "@every 1m"
storageSecretName: snap-secret
Expand Down
10 changes: 5 additions & 5 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,30 +18,30 @@ aliases:
# Installation Guide

## Install KubeDB CLI
KubeDB provides a CLI to work with database objects. Download pre-built binaries from [k8sdb/cli Github releases](https://github.com/k8sdb/cli/releases) and put the binary to some directory in your `PATH`. To install on Linux 64-bit and MacOS 64-bit you can run the following commands:
KubeDB provides a CLI to work with database objects. Download pre-built binaries from [kubedb/cli Github releases](https://github.com/kubedb/cli/releases) and put the binary to some directory in your `PATH`. To install on Linux 64-bit and MacOS 64-bit you can run the following commands:

```console
# Linux amd 64-bit
wget -O kubedb https://github.com/k8sdb/cli/releases/download/0.7.1/kubedb-linux-amd64 \
wget -O kubedb https://github.com/kubedb/cli/releases/download/0.7.1/kubedb-linux-amd64 \
&& chmod +x kubedb \
&& sudo mv kubedb /usr/local/bin/

# Mac 64-bit
wget -O kubedb https://github.com/k8sdb/cli/releases/download/0.7.1/kubedb-darwin-amd64 \
wget -O kubedb https://github.com/kubedb/cli/releases/download/0.7.1/kubedb-darwin-amd64 \
&& chmod +x kubedb \
&& sudo mv kubedb /usr/local/bin/
```

If you prefer to install KubeDB cli from source code, you will need to set up a GO development environment following [these instructions](https://golang.org/doc/code.html). Then, install `kubedb` CLI using `go get` from source code.

```bash
go get github.com/k8sdb/cli/...
go get github.com/kubedb/cli/...
```

Please note that this will install KubeDB cli from master branch which might include breaking and/or undocumented changes.

## Install KubeDB Operator
To use KubeDB, you will need to install KubeDB [operator](https://github.com/k8sdb/operator). `kubedb init` command will deploy operator for kubedb databases.
To use KubeDB, you will need to install KubeDB [operator](https://github.com/kubedb/operator). `kubedb init` command will deploy operator for kubedb databases.

```console
$ kubedb init
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/kubedb.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Command line interface for KubeDB

KubeDB by AppsCode - Kubernetes ready production-grade Databases

Find more information at https://github.com/k8sdb/cli.
Find more information at https://github.com/kubedb/cli.

```
kubedb [flags]
Expand Down
14 changes: 7 additions & 7 deletions docs/tutorials/postgres/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ spec:
scriptSource:
scriptPath: "postgres-init-scripts/run.sh"
gitRepo:
repository: "https://github.com/k8sdb/postgres-init-scripts.git"
repository: "https://github.com/kubedb/postgres-init-scripts.git"

$ kubedb create -f ./docs/examples/postgres/demo-1.yaml
validating "./docs/examples/postgres/demo-1.yaml"
Expand All @@ -84,7 +84,7 @@ Here,

- `spec.storage` specifies the StorageClass of PVC dynamically allocated to store data for this database. This storage spec will be passed to the StatefulSet created by KubeDB operator to run database pods. You can specify any StorageClass available in your cluster with appropriate resource requests. If no storage spec is given, an `emptyDir` is used.

- `spec.init.scriptSource` specifies a bash script used to initialize the database after it is created. In this tutorial, `run.sh` script from the git repository `https://github.com/k8sdb/postgres-init-scripts.git` is used to create a `dashboard` table in `data` schema.
- `spec.init.scriptSource` specifies a bash script used to initialize the database after it is created. In this tutorial, `run.sh` script from the git repository `https://github.com/kubedb/postgres-init-scripts.git` is used to create a `dashboard` table in `data` schema.

KubeDB operator watches for `Postgres` objects using Kubernetes api. When a `Postgres` object is created, KubeDB operator will create a new StatefulSet and a ClusterIP Service with the matching tpr name. KubeDB operator will also create a governing service for StatefulSets with the name `kubedb`, if one is not already present. If [RBAC is enabled](/docs/tutorials/rbac.md), a ClusterRole, ServiceAccount and ClusterRoleBinding with the matching tpr name will be created and used as the service account name for the corresponding StatefulSet.

Expand Down Expand Up @@ -164,7 +164,7 @@ spec:
init:
scriptSource:
gitRepo:
repository: https://github.com/k8sdb/postgres-init-scripts.git
repository: https://github.com/kubedb/postgres-init-scripts.git
scriptPath: postgres-init-scripts/run.sh
resources: {}
storage:
Expand Down Expand Up @@ -361,7 +361,7 @@ spec:
scriptSource:
scriptPath: "postgres-init-scripts/run.sh"
gitRepo:
repository: "https://github.com/k8sdb/postgres-init-scripts.git"
repository: "https://github.com/kubedb/postgres-init-scripts.git"
backupSchedule:
cronExpression: "@every 1m"
storageSecretName: snap-secret
Expand Down Expand Up @@ -508,7 +508,7 @@ spec:
init:
scriptSource:
gitRepo:
repository: https://github.com/k8sdb/postgres-init-scripts.git
repository: https://github.com/kubedb/postgres-init-scripts.git
scriptPath: postgres-init-scripts/run.sh
resources: {}
storage:
Expand Down Expand Up @@ -569,7 +569,7 @@ spec:
init:
scriptSource:
gitRepo:
repository: https://github.com/k8sdb/postgres-init-scripts.git
repository: https://github.com/kubedb/postgres-init-scripts.git
scriptPath: postgres-init-scripts/run.sh
resources: {}
storage:
Expand Down Expand Up @@ -626,7 +626,7 @@ spec:
init:
scriptSource:
gitRepo:
repository: https://github.com/k8sdb/postgres-init-scripts.git
repository: https://github.com/kubedb/postgres-init-scripts.git
scriptPath: postgres-init-scripts/run.sh
resources: {}
storage:
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ spec:
init:
scriptSource:
gitRepo:
repository: https://github.com/k8sdb/postgres-init-scripts.git
repository: https://github.com/kubedb/postgres-init-scripts.git
scriptPath: postgres-init-scripts/run.sh
resources: {}
storage:
Expand Down
2 changes: 1 addition & 1 deletion glide-slow
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# - ???
# - Profit

pushd $GOPATH/src/github.com/k8sdb/cli
pushd $GOPATH/src/github.com/kubedb/cli

glide up -v
glide vc --only-code --no-tests
Expand Down
40 changes: 20 additions & 20 deletions glide.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 0c467fe

Please sign in to comment.