Hugo-based documentation site (#317)
Not much content yet; this is a start.
This commit is contained in:
Soam Vasani
@@ -0,0 +1 @@
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
## Fission Documentation
|
||||
|
||||
### Introduction: what's Fission?
|
||||
|
||||
### Concepts
|
||||
|
||||
### Architecture
|
||||
|
||||
### Deployment guide
|
||||
|
||||
Fission installation guide
|
||||
|
||||
Fission upgrade guide
|
||||
|
||||
### User guides
|
||||
|
||||
Creating your first function
|
||||
|
||||
Viewing function logs
|
||||
|
||||
Troubleshooting
|
||||
|
||||
Creating a Slack bot
|
||||
|
||||
Creating a Kubernetes Watch
|
||||
|
||||
Creating
|
||||
|
||||
### Reference manual
|
||||
|
||||
CLI
|
||||
|
||||
API
|
||||
@@ -0,0 +1,146 @@
|
||||
---
|
||||
title: "Fission Installation Guide"
|
||||
date: 2017-09-07T20:10:05-07:00
|
||||
draft: true
|
||||
---
|
||||
|
||||
Welcome! This guide will get you up and running with Fission on a
|
||||
Kubernetes cluster.
|
||||
|
||||
### Cluster preliminaries
|
||||
|
||||
Let's ensure you have the Kubernetes CLI and Helm installed and
|
||||
ready. If you already have these tools, [skip to the next section](#install-fission).
|
||||
|
||||
#### Kubernetes CLI
|
||||
|
||||
Ensure you have the Kubernetes CLI.
|
||||
|
||||
You can get the Kubernetes CLI for OSX like this:
|
||||
```
|
||||
$ curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/darwin/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin
|
||||
```
|
||||
|
||||
Or, for Linux:
|
||||
```
|
||||
$ curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin
|
||||
```
|
||||
|
||||
Ensure you have access to a cluster; use kubectl to check your
|
||||
Kubernetes version:
|
||||
|
||||
```
|
||||
$ kubectl version
|
||||
```
|
||||
|
||||
We need at least Kubernetes 1.6 (older versions may work, but we don't
|
||||
test them).
|
||||
|
||||
#### Set up helm
|
||||
|
||||
Helm is an installer for Kubernetes. If you already use helm, [skip to
|
||||
the next section](#install-fission).
|
||||
|
||||
First, you'll need the helm CLI:
|
||||
|
||||
On __OS X__:
|
||||
```
|
||||
$ curl -L https://storage.googleapis.com/kubernetes-helm/helm-v2.6.1-darwin-amd64.tar.gz
|
||||
|
||||
$ tar xzf helm-v2.6.1-darwin-amd64.tar.gz
|
||||
|
||||
$ mv darwin-amd64/helm /usr/local/bin
|
||||
```
|
||||
|
||||
On __Linux__:
|
||||
```
|
||||
$ curl -L https://storage.googleapis.com/kubernetes-helm/helm-v2.6.1-linux-amd64.tar.gz
|
||||
|
||||
$ tar xzf helm-v2.6.1-linux-amd64.tar.gz
|
||||
|
||||
$ mv linux-amd64/helm /usr/local/bin
|
||||
```
|
||||
|
||||
Next, install the Helm server on your Kubernetes cluster:
|
||||
|
||||
```
|
||||
$ kubectl -n kube-system create sa tiller
|
||||
|
||||
$ kubectl create clusterrolebinding tiller --clusterrole cluster-admin --serviceaccount=kube-system:tiller
|
||||
|
||||
$ helm init --service-account tiller
|
||||
```
|
||||
|
||||
(The first two commands are there to make sure that helm is allowed to
|
||||
install stuff on Kubernetes, in the common case that your cluster has
|
||||
role-based access control.)
|
||||
|
||||
|
||||
### Install Fission
|
||||
|
||||
```
|
||||
$ helm repo add fission-charts https://fission-charts.github.io
|
||||
|
||||
$ helm install --namespace fission fission-all
|
||||
```
|
||||
|
||||
#### Minikube
|
||||
|
||||
On minikube, you'll need to pass one additional option to the helm
|
||||
install command:
|
||||
|
||||
```
|
||||
$ helm repo add fission-charts https://fission-charts.github.io
|
||||
|
||||
$ helm install --namespace fission fission-all --set serviceType=NodePort
|
||||
```
|
||||
|
||||
|
||||
#### Minimal version
|
||||
|
||||
The fission-all helm chart installs a full set of services including
|
||||
the NATS message queue, influxDB for logs, etc. If you want a more
|
||||
minimal setup, you can install the fission-core chart instead.
|
||||
|
||||
### Install Fission CLI
|
||||
|
||||
#### Mac OS
|
||||
|
||||
Get the CLI binary for Mac:
|
||||
|
||||
```
|
||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/nightly20170705/fission-cli-osx && chmod +x fission && sudo mv fission /usr/local/bin/
|
||||
```
|
||||
|
||||
#### Linux
|
||||
|
||||
```
|
||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/nightly20170705/fission-cli-linux && chmod +x fission && sudo mv fission /usr/local/bin/
|
||||
```
|
||||
|
||||
#### Windows
|
||||
|
||||
For Windows, you can use the linux binary on WSL. Or you can download
|
||||
this windows executable: [fission.exe](https://github.com/fission/fission/releases/download/nightly20170705/fission-cli-windows.exe)
|
||||
|
||||
### Set environment vars
|
||||
|
||||
|
||||
|
||||
### Run an example
|
||||
|
||||
Finally, you're ready to use Fission!
|
||||
|
||||
```
|
||||
$ fission env create --name nodejs --image fission/node-env:v0.2.1
|
||||
|
||||
$ curl -LO https://raw.githubusercontent.com/fission/fission/master/examples/nodejs/hello.js
|
||||
|
||||
$ fission function create --name hello --env nodejs --code hello.js
|
||||
|
||||
$ fission route create --method GET --url /hello --function hello
|
||||
|
||||
$ curl http://$FISSION_ROUTER/hello
|
||||
Hello, world!
|
||||
```
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
title: "Kubernetes Quick Install"
|
||||
date: 2017-09-07T20:10:05-07:00
|
||||
draft: true
|
||||
---
|
||||
|
||||
This is a quick guide to help you get started running Kubernetes on
|
||||
your laptop (or on the cloud).
|
||||
|
||||
(This isn't meant as a production Kuberenetes guide; it's merely
|
||||
intended to give you something quickly so you can try Fission on it.)
|
||||
|
||||
## Minikube
|
||||
|
||||
Minikube is the simplest way to run Kubernetes on your laptop.
|
||||
|
||||
### Install and start Kubernetes on OSX:
|
||||
|
||||
```
|
||||
$ curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/darwin/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin
|
||||
|
||||
$ curl -Lo minikube https://storage.googleapis.com/minikube/releases/v0.16.0/minikube-darwin-amd64 && chmod +x minikube && sudo mv minikube /usr/local/bin/
|
||||
|
||||
$ minikube start
|
||||
```
|
||||
|
||||
### Or, install and start Kubernetes on Linux:
|
||||
|
||||
```
|
||||
$ curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin
|
||||
|
||||
$ curl -Lo minikube https://storage.googleapis.com/minikube/releases/v0.16.0/minikube-linux-amd64 && chmod +x minikube && sudo mv minikube /usr/local/bin/
|
||||
|
||||
$ minikube start
|
||||
```
|
||||
|
||||
## Google Container Engine
|
||||
|
||||
You can use [Google Container Engine's](https://cloud.google.com/container-engine/) free trial to
|
||||
get a 3-node cluster. Hop over to [Google Cloud](https://cloud.google.com/container-engine/) to set that up.
|
||||
|
||||
Reference in New Issue
Block a user