Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

readme-update #122

Merged
merged 2 commits into from
Jul 29, 2021
Merged

readme-update #122

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4cbe479
readme-update
Jul 29, 2021
cc7b1bb
more cleanup
Jul 29, 2021
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
110 changes: 1 addition & 109 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Ketch is an application delivery framework that facilitates the deployment and m
# Contents
* [Ketch Overview](https://learn.theketch.io/docs/overview)
* [Architecture](https://learn.theketch.io/docs/architecture)
* [Getting Started](#getting-started)
* [Getting Started](https://learn.theketch.io/docs/getting-started)
* [Deploying a sample application](https://learn.theketch.io/docs/getting-started#deploying-an-application)
* [Get Involved](#get-involved)
* [Office Hours](#office-hours)
Expand All @@ -21,118 +21,10 @@ Ketch is an application delivery framework that facilitates the deployment and m
## Architecture Diagram
![Architecture](./img/ketch-architecture.png)

## Getting Started

### Download and Install Ketch
The latest Ketch release can be found [here](https://github.com/shipa-corp/ketch/releases). Use the following commands
to install Ketch,

Install latest at /usr/local/bin default location

```bash
curl -s https://raw.githubusercontent.com/shipa-corp/ketch/main/install.sh | bash
```

Alternatively, you can install specific tag at a target location, for example command below installs ketch version v0.4.0 in current directory:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this bit about version and install dir are missing from theketch.io docs. They be useful.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch @stinkyfingers, fixed, https://learn.theketch.io/docs/getting-started#ketch-cli


```bash
curl -s https://raw.githubusercontent.com/shipa-corp/ketch/main/install.sh | INSTALL_DIR=. TAG=v0.4.0 bash
```



### Install Ingress Controller

At present, Ketch supports Istio and Traefik ingress controllers.

Here is how you can install Traefik:

Use [Helm](https://helm.sh/docs/intro/install/) to install Traefik.

```bash
helm repo add traefik https://helm.traefik.io/traefik
helm repo update
helm install traefik traefik/traefik
```

Or you can install Istio:

```bash
curl -Ls https://istio.io/downloadIstio | ISTIO_VERSION=1.9.0 sh -
export PATH=$PWD/istio-1.9.0/bin:$PATH
istioctl install --set profile=demo
```

### Install Cert Manager.
```bash
kubectl apply --validate=false -f https://github.com/jetstack/cert-manager/releases/download/v1.0.3/cert-manager.yaml
```
### Install Ketch controller.
```bash
kubectl apply -f https://github.com/shipa-corp/ketch/releases/download/v0.4.0/ketch-controller.yaml
```

Thats it!

## Using Ketch

Learn more about Ketch at [Ketch documentation](https://learn.theketch.io/docs)

### Quick Start
Deploying apps is easy once you've installed Ketch. First, create a framework. Then create app(s) adding them to the framework and finally
deploy the app(s). The following example illustrates these steps.

```bash
# Add a framework with ingress Traefik (default), replace ingress IP address by your ingress IP address
ketch framework add myframework --ingress-service-endpoint 35.247.8.23 --ingress-type traefik

# Deploy app using docker image
ketch app deploy -k myframework bulletinboard -i docker.io/shipasoftware/bulletinboard:1.0

# Check app status
ketch app list

NAME FRAMEWORK STATE ADDRESSES BUILDER DESCRIPTION
bulletinboard myframework 1 running http://bulletinboard.35.247.8.23.shipa.cloud
```
After you deploy your application, you can access it at the address associated with it using the `ketch app list`, in
this example `bulletinboard.35.247.8.23.shipa.cloud`.

### Usage
For details see https://theketch.io.

```bash
Usage:
ketch [flags]
ketch [command]

Available Commands:
app Manage applications
cname Manage cnames of an application
env Manage an app's environment variables
help Help about any command
builder Manage pack builders
framework Manage frameworks
unit Manage an app's units

Flags:
-h, --help help for ketch
-v, --version version for ketch

Use "ketch [command] --help" for more information about a command.
```

## Shell autocompletion

Ketch supports shell autocompletion for:
- bash
- zsh
- fish
- PowerShell

To get instructions on how to install shell autocompletion use following command:
`ketch completion -h`

## Get Involved

* Discuss Ketch on [slack](https://join.slack.com/t/shipaco/shared_invite/zt-mqy8plp1-DxFKP102VJtUn5q9tzom9Q) or our [dev mailing list](https://groups.google.com/g/ketch-dev)
Expand Down