Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6a3e326f36 | ||
|
|
f0dc2554a1 | ||
|
|
2ece0db13f | ||
|
|
0e3a270d27 | ||
|
|
6a7381c575 | ||
|
|
0aff2f214d | ||
|
|
dec4a39c15 | ||
|
|
7577339912 | ||
|
|
6375819195 | ||
|
|
0b34abcada | ||
|
|
772fdfa15c | ||
|
|
7198b24028 | ||
|
|
eb696432d8 | ||
|
|
2d359f879a | ||
|
|
94e2f11ea6 | ||
|
|
ff01cf2452 | ||
|
|
400e19a48f | ||
|
|
0194f53e12 | ||
|
|
fef1469c61 | ||
|
|
cf53e17be5 | ||
|
|
449f49515a | ||
|
|
d01b309fc7 | ||
|
|
12299df811 | ||
|
|
95a50dbbd6 | ||
|
|
8014c83b02 | ||
|
|
db2f620121 | ||
|
|
f9ca626940 | ||
|
|
1dbf8f9243 | ||
|
|
9406720e8a | ||
|
|
2a06705320 | ||
|
|
d39944e04d | ||
|
|
6f6b52438a | ||
|
|
5baf67f143 | ||
|
|
6d61f6e5eb | ||
|
|
6ab902e7a3 | ||
|
|
ed7d088bbc | ||
|
|
c0058153a0 | ||
|
|
a8482a8b89 | ||
|
|
a23f8acffc | ||
|
|
77be3379b2 | ||
|
|
03046170dc | ||
|
|
c0acaa74c3 | ||
|
|
8708fdec93 | ||
|
|
6b188c053a | ||
|
|
0fd6114218 | ||
|
|
9ae06f56c8 | ||
|
|
704a8094e6 | ||
|
|
6f54565195 | ||
|
|
90206fbaa0 | ||
|
|
8fb4aca231 | ||
|
|
70a93a7302 | ||
|
|
c76b6bacc0 | ||
|
|
15bedfb688 | ||
|
|
1447e6949d | ||
|
|
048ab6149a | ||
|
|
8a0abc59db | ||
|
|
039e003af6 | ||
|
|
1ea665386a | ||
|
|
e7c9a67a68 | ||
|
|
afd7f7f436 | ||
|
|
b4300feabc | ||
|
|
a3826046a5 | ||
|
|
d852ddd91c | ||
|
|
1edb9723e8 | ||
|
|
ca51a5fe4c | ||
|
|
714f32d290 | ||
|
|
7ddbea59a2 | ||
|
|
b895f98e88 | ||
|
|
1b1c4f1380 | ||
|
|
5e2f984136 | ||
|
|
23942fdf7d | ||
|
|
b9a559af2f | ||
|
|
1428c64b4f | ||
|
|
866e0288c9 | ||
|
|
f83512f176 | ||
|
|
bd609fa18e | ||
|
|
e5b137fe24 | ||
|
|
245506efe3 | ||
|
|
a1ed698fa8 | ||
|
|
9a21e14a84 | ||
|
|
f695a81c46 | ||
|
|
9e9a0c1ec6 | ||
|
|
281a492149 | ||
|
|
4d0e6af5de | ||
|
|
46895b03c8 | ||
|
|
d9b5c2e560 | ||
|
|
841c7ef845 | ||
|
|
7752abaf05 | ||
|
|
818876dd08 | ||
|
|
266922da26 | ||
|
|
a98370ca63 | ||
|
|
bce45d6d25 | ||
|
|
93dde93afe | ||
|
|
08898cdd17 | ||
|
|
2effade15d | ||
|
|
610790244b | ||
|
|
054f9bcd85 | ||
|
|
ebdb13f7d0 | ||
|
|
8ad365aaec | ||
|
|
982665f448 | ||
|
|
feaa6746c3 | ||
|
|
b61bf9324f | ||
|
|
b18c965860 | ||
|
|
8f19a9bedb | ||
|
|
1bf38cbca6 | ||
|
|
ce110a8dff | ||
|
|
802ae08adb | ||
|
|
77430f7438 | ||
|
|
3aaabc909b | ||
|
|
4e445bb3cc | ||
|
|
a5cb1d3e3d | ||
|
|
582c9808b5 | ||
|
|
398c58365a | ||
|
|
9deb4f53db | ||
|
|
3c513c7f61 | ||
|
|
c56ed598cb | ||
|
|
e6191e3c69 | ||
|
|
e7dbba634c | ||
|
|
a033d3c432 | ||
|
|
3f81510729 | ||
|
|
07c7b759d2 | ||
|
|
6af13e7e29 | ||
|
|
cc62e62229 | ||
|
|
1eb0453ce4 | ||
|
|
4cf195768e | ||
|
|
31ba992726 | ||
|
|
0c92f59c38 | ||
|
|
c00f76b561 | ||
|
|
91094cf659 | ||
|
|
1935098404 | ||
|
|
7d83859cfb | ||
|
|
986b300b8c | ||
|
|
4f7eb19b7c | ||
|
|
0a733b20c3 | ||
|
|
b7c97cec8c | ||
|
|
b578819202 | ||
|
|
01bcfad44a | ||
|
|
8df520721c |
@@ -1,4 +1,6 @@
|
||||
fission-bundle/fission-bundle
|
||||
fission/fission
|
||||
|
||||
# Pycharm IDE
|
||||
.idea
|
||||
environments/php7/vendor/
|
||||
@@ -9,5 +11,6 @@ environments/php7/vendor/
|
||||
*.tmp
|
||||
*~
|
||||
|
||||
.DS_Store
|
||||
vendor/
|
||||
local/
|
||||
local/
|
||||
|
||||
@@ -2,6 +2,10 @@ sudo: required
|
||||
|
||||
dist: trusty
|
||||
|
||||
branches:
|
||||
only:
|
||||
- master
|
||||
|
||||
language: go
|
||||
|
||||
go:
|
||||
@@ -18,6 +22,7 @@ services:
|
||||
before_install:
|
||||
- sudo apt-get update
|
||||
- sudo apt-get -y -o Dpkg::Options::="--force-confnew" install docker-ce
|
||||
- sudo sysctl net.ipv6.conf.all.disable_ipv6=0
|
||||
|
||||
install:
|
||||
- go get github.com/Masterminds/glide
|
||||
@@ -28,14 +33,17 @@ env:
|
||||
|
||||
script:
|
||||
- cd ${TRAVIS_BUILD_DIR}
|
||||
- glide install
|
||||
- glide install -v
|
||||
- ./fission-bundle/build.sh
|
||||
- hack/verify-gofmt.sh
|
||||
- hack/verify-govet.sh
|
||||
- hack/runtests.sh
|
||||
- test/build_and_test.sh
|
||||
- test/upgrade/fission_upgrade_test.sh
|
||||
|
||||
notifications:
|
||||
slack:
|
||||
secure: YZ34vsfw1TtftJypg1MyP4+ihONI4gaxeS3FghBQli6+EezjzcxOXyj5VD+x0ucXfDeTaDrFfmVN0SAGObOoZUE+ea9KAoTo50tRLaD9kwOTACiekZalC4uuBguH0D1/A6vlbU8dchsr9mvIhbisG6mTncdPtqGYYHtyBQme6ngmmHbVAQFZcIBHmNuDb/HWhSr8KMEuyB6+mBXLYELHnXnf26cOhdGNaagqCOJTiemX85RGwIuOPxyBhKDFMLyHohDT7FJMH/qijveE6YgOYTQC5nYc2Np1KvC7hQkIu4nuyczyYlrNQl/TWv+SVI8PjIs0PYuCuD3gUqoVEi8d94HbrOPzFEpbwDS9P4qL39DGmco1Q56Vqxe6sRI0vDWPb5gCP1lSgs3PMECVn7Wor/pTvcL+C+U2jLwWJUl0vbyWCL7ngl/3iTssV7qBpUrI7Oclwp8LrQo9fPj0DL4gE9rNanpEWjQ6yPGaysIL1zLHtRghhm52A22NJGp71jkS2KEpLi6ZWFYjMeuXw5eOQFhqFlzyRJOmLYa3B607TLWuyo2L2CxAfMmq0FGfemvrkLZIWtlQKK4y9ImpsURwaGT2XCtThFtHl77wEss913nC+T2dX3O5Bl0UmxFd5S3mVM109I8c4lDosxnAjRfS9MheFlrG0gjSJSBCw57x7f0=
|
||||
rooms:
|
||||
secure: YZ34vsfw1TtftJypg1MyP4+ihONI4gaxeS3FghBQli6+EezjzcxOXyj5VD+x0ucXfDeTaDrFfmVN0SAGObOoZUE+ea9KAoTo50tRLaD9kwOTACiekZalC4uuBguH0D1/A6vlbU8dchsr9mvIhbisG6mTncdPtqGYYHtyBQme6ngmmHbVAQFZcIBHmNuDb/HWhSr8KMEuyB6+mBXLYELHnXnf26cOhdGNaagqCOJTiemX85RGwIuOPxyBhKDFMLyHohDT7FJMH/qijveE6YgOYTQC5nYc2Np1KvC7hQkIu4nuyczyYlrNQl/TWv+SVI8PjIs0PYuCuD3gUqoVEi8d94HbrOPzFEpbwDS9P4qL39DGmco1Q56Vqxe6sRI0vDWPb5gCP1lSgs3PMECVn7Wor/pTvcL+C+U2jLwWJUl0vbyWCL7ngl/3iTssV7qBpUrI7Oclwp8LrQo9fPj0DL4gE9rNanpEWjQ6yPGaysIL1zLHtRghhm52A22NJGp71jkS2KEpLi6ZWFYjMeuXw5eOQFhqFlzyRJOmLYa3B607TLWuyo2L2CxAfMmq0FGfemvrkLZIWtlQKK4y9ImpsURwaGT2XCtThFtHl77wEss913nC+T2dX3O5Bl0UmxFd5S3mVM109I8c4lDosxnAjRfS9MheFlrG0gjSJSBCw57x7f0=
|
||||
on_success: change
|
||||
on_failure: always
|
||||
|
||||
@@ -0,0 +1,429 @@
|
||||
# 0.7.1
|
||||
[Documentation](http://fission.io/docs/0.7.1/)
|
||||
## Downloads for 0.7.1
|
||||
|
||||
|
||||
filename | sha256 hash
|
||||
-------- | -----------
|
||||
[fission-core-0.7.1.tgz](https://github.com/fission/fission/releases/download/0.7.1/fission-core-0.7.1.tgz) | `5d5606c79b5d83c2e88c371b6bea4a49a599f1a1e26674db3388a63278a47c2c`
|
||||
[fission-all-0.7.1.tgz](https://github.com/fission/fission/releases/download/0.7.1/fission-all-0.7.1.tgz) | `0ea6887f39c0f59463b49e632294152c926b62b5afc65202c80045ff71735b05`
|
||||
[fission-cli-osx](https://github.com/fission/fission/releases/download/0.7.1/fission-cli-osx) | `765b35bd1e4565b9819bed157ca0206a0e5217394d0b253a0cdd9a318ef4d9a5`
|
||||
[fission-cli-linux](https://github.com/fission/fission/releases/download/0.7.1/fission-cli-linux) | `5eacdff0a0f3d6d3a1c2aa8d6164bc6524b1f001298cb2e82b60cf1c762a5a9e`
|
||||
[fission-cli-windows.exe](https://github.com/fission/fission/releases/download/0.7.1/fission-cli-windows.exe) | `c237b1ee1a8f2b26038555388a438e4fff5725c90d4128baaa32a77ccf990d2e`
|
||||
|
||||
# Change Log
|
||||
|
||||
## [0.7.1](https://github.com/fission/fission/tree/0.7.1) (2018-04-10)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/0.7.0...0.7.1)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Prevent releasing idle connections because transport is shared. [\#609](https://github.com/fission/fission/pull/609) ([smruthi2187](https://github.com/smruthi2187))
|
||||
- Fix components crash before crds creation [\#602](https://github.com/fission/fission/pull/602) ([life1347](https://github.com/life1347))
|
||||
- updates to changelog. [\#598](https://github.com/fission/fission/pull/598) ([smruthi2187](https://github.com/smruthi2187))
|
||||
- changes needed for release 0.7.0 [\#597](https://github.com/fission/fission/pull/597) ([smruthi2187](https://github.com/smruthi2187))
|
||||
- `fission X create --spec` flags for env and trigger create commands [\#607](https://github.com/fission/fission/pull/607) ([soamvasani](https://github.com/soamvasani))
|
||||
- Updating releasing guideliness with a few more details. [\#599](https://github.com/fission/fission/pull/599) ([smruthi2187](https://github.com/smruthi2187))
|
||||
- Add deprecated message to subcommand pods [\#592](https://github.com/fission/fission/pull/592) ([life1347](https://github.com/life1347))
|
||||
- Add validate function to crd resource and do validate before creation/update [\#580](https://github.com/fission/fission/pull/580) ([life1347](https://github.com/life1347))
|
||||
- Invalidate stale router cache entry with podIP's for deleted pods. [\#546](https://github.com/fission/fission/pull/546) ([smruthi2187](https://github.com/smruthi2187))
|
||||
- Use a separate controller loop to watch functions change and create a service [\#544](https://github.com/fission/fission/pull/544) ([life1347](https://github.com/life1347))
|
||||
- E2E test for NATS-streaming trigger [\#338](https://github.com/fission/fission/pull/338) ([soamvasani](https://github.com/soamvasani))
|
||||
|
||||
## [0.7.0](https://github.com/fission/fission/tree/0.7.0) (2018-04-02)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/0.6.1...0.7.0)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- bug fix: spec dir flag [\#595](https://github.com/fission/fission/pull/595) ([xiekeyang](https://github.com/xiekeyang))
|
||||
- Add steps to set FISSION\_ROUTER env variable & update docs [\#593](https://github.com/fission/fission/pull/593) ([life1347](https://github.com/life1347))
|
||||
- Adding routerUrl parameter for kubewatch, timer, message queue trigge… [\#591](https://github.com/fission/fission/pull/591) ([smruthi2187](https://github.com/smruthi2187))
|
||||
- Uses proper way to get server URL [\#587](https://github.com/fission/fission/pull/587) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Check if the requested file already exists in fetcher and skip fetch [\#584](https://github.com/fission/fission/pull/584) ([smruthi2187](https://github.com/smruthi2187))
|
||||
- Add golang example to installation guide [\#578](https://github.com/fission/fission/pull/578) ([clee](https://github.com/clee))
|
||||
- Fixes the issue \#559 with env versions [\#569](https://github.com/fission/fission/pull/569) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Add post-upgrade-job to track fission upgrade [\#564](https://github.com/fission/fission/pull/564) ([life1347](https://github.com/life1347))
|
||||
- Prepending a slash to user input url if missing. [\#547](https://github.com/fission/fission/pull/547) ([smruthi2187](https://github.com/smruthi2187))
|
||||
- Add verbosity flag and verbose logs for portforwarder [\#575](https://github.com/fission/fission/pull/575) ([soamvasani](https://github.com/soamvasani))
|
||||
- Spec validator, better errors, apply waits for previous build [\#560](https://github.com/fission/fission/pull/560) ([soamvasani](https://github.com/soamvasani))
|
||||
- Tests for function update [\#550](https://github.com/fission/fission/pull/550) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Show fission deployment version with cli [\#538](https://github.com/fission/fission/pull/538) ([life1347](https://github.com/life1347))
|
||||
|
||||
## [0.6.1](https://github.com/fission/fission/tree/0.6.1) (2018-03-22)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/0.6.0...0.6.1)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- This change fixes an error in a yaml file in the fission-core chart. [\#563](https://github.com/fission/fission/pull/563) ([yiqunding](https://github.com/yiqunding))
|
||||
- \[ci skip\] update release number [\#561](https://github.com/fission/fission/pull/561) ([appleboy](https://github.com/appleboy))
|
||||
- Fixes \#537 - warning should not be given when updating to newdeploy [\#545](https://github.com/fission/fission/pull/545) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Docs update [\#542](https://github.com/fission/fission/pull/542) ([soamvasani](https://github.com/soamvasani))
|
||||
- Release script updates [\#541](https://github.com/fission/fission/pull/541) ([soamvasani](https://github.com/soamvasani))
|
||||
- Show warning when trying to create a route with non-existent function \(\#238\) [\#539](https://github.com/fission/fission/pull/539) ([life1347](https://github.com/life1347))
|
||||
- Fix executor failed to clean cache & kubeobjs after function deleted \(\#533\) [\#534](https://github.com/fission/fission/pull/534) ([life1347](https://github.com/life1347))
|
||||
- Delete healthz log [\#525](https://github.com/fission/fission/pull/525) ([smruthi2187](https://github.com/smruthi2187))
|
||||
- Always retry when istio is enabled. [\#536](https://github.com/fission/fission/pull/536) ([life1347](https://github.com/life1347))
|
||||
- Fix executor tries to create a new deployment when a function is updated [\#524](https://github.com/fission/fission/pull/524) ([life1347](https://github.com/life1347))
|
||||
- Add container spec config options to \(build\) environments [\#413](https://github.com/fission/fission/pull/413) ([erwinvaneyk](https://github.com/erwinvaneyk))
|
||||
|
||||
## [0.6.0](https://github.com/fission/fission/tree/0.6.0) (2018-03-01)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/latest...0.6.0)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Detect fission namespace in cli [\#519](https://github.com/fission/fission/pull/519) ([soamvasani](https://github.com/soamvasani))
|
||||
- Default values for FISSION\_\* env vars [\#518](https://github.com/fission/fission/pull/518) ([soamvasani](https://github.com/soamvasani))
|
||||
- Add chart version to job name [\#516](https://github.com/fission/fission/pull/516) ([soamvasani](https://github.com/soamvasani))
|
||||
- Fix CLI not update function's secret/configmap correctly [\#512](https://github.com/fission/fission/pull/512) ([life1347](https://github.com/life1347))
|
||||
- Adds latest tags and pushes to dockerhub for fetcher and fission-bundle [\#509](https://github.com/fission/fission/pull/509) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Fixes the backward compatibility with older environment versions [\#508](https://github.com/fission/fission/pull/508) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Update Fn: Executor New Deployment [\#504](https://github.com/fission/fission/pull/504) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Adds default resources for fetcher pod [\#500](https://github.com/fission/fission/pull/500) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Documentation Revamp [\#496](https://github.com/fission/fission/pull/496) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Delete and list orphan pkgs [\#468](https://github.com/fission/fission/pull/468) ([smruthi2187](https://github.com/smruthi2187))
|
||||
- Service type ClusterIP - Controller port forward through CLI [\#431](https://github.com/fission/fission/pull/431) ([prithviramesh](https://github.com/prithviramesh))
|
||||
- Istio integration [\#421](https://github.com/fission/fission/pull/421) ([life1347](https://github.com/life1347))
|
||||
- Implement support for Azure storage message queue triggers [\#371](https://github.com/fission/fission/pull/371) ([peterhuene](https://github.com/peterhuene))
|
||||
|
||||
## [latest](https://github.com/fission/fission/tree/latest) (2018-03-01)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/0.5.0...latest)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Release checklist [\#522](https://github.com/fission/fission/pull/522) ([soamvasani](https://github.com/soamvasani))
|
||||
- Fix post-install-job container failure due to command not found [\#514](https://github.com/fission/fission/pull/514) ([life1347](https://github.com/life1347))
|
||||
- Replace the release with the latest tag. [\#513](https://github.com/fission/fission/pull/513) ([smruthi2187](https://github.com/smruthi2187))
|
||||
- Go: Set image to right version, update example readme [\#497](https://github.com/fission/fission/pull/497) ([soamvasani](https://github.com/soamvasani))
|
||||
- Remove a noisy log from router [\#495](https://github.com/fission/fission/pull/495) ([soamvasani](https://github.com/soamvasani))
|
||||
- Improve release script [\#494](https://github.com/fission/fission/pull/494) ([life1347](https://github.com/life1347))
|
||||
- Update SHA256 HASH in CHANGELOG.md due to binaries update [\#493](https://github.com/fission/fission/pull/493) ([life1347](https://github.com/life1347))
|
||||
- Go builder for single file functions [\#492](https://github.com/fission/fission/pull/492) ([soamvasani](https://github.com/soamvasani))
|
||||
- CI modifications [\#491](https://github.com/fission/fission/pull/491) ([smruthi2187](https://github.com/smruthi2187))
|
||||
- Add upgrade guide from 0.4.x to 0.5.0 [\#490](https://github.com/fission/fission/pull/490) ([life1347](https://github.com/life1347))
|
||||
- Version -\> 0.5.0 [\#489](https://github.com/fission/fission/pull/489) ([life1347](https://github.com/life1347))
|
||||
|
||||
## [0.5.0](https://github.com/fission/fission/tree/0.5.0) (2018-02-07)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/0.4.1...0.5.0)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Migrate project.json to dotnet.csproj & do build in dotnet container [\#488](https://github.com/fission/fission/pull/488) ([life1347](https://github.com/life1347))
|
||||
- Fix binary environment build failure due to package not found [\#487](https://github.com/fission/fission/pull/487) ([life1347](https://github.com/life1347))
|
||||
- Fix possible context leak problem [\#483](https://github.com/fission/fission/pull/483) ([life1347](https://github.com/life1347))
|
||||
- Removed limit on max number of channels in NATS Streaming deployment [\#482](https://github.com/fission/fission/pull/482) ([erwinvaneyk](https://github.com/erwinvaneyk))
|
||||
- Add glide flag to strip nested vendor [\#480](https://github.com/fission/fission/pull/480) ([life1347](https://github.com/life1347))
|
||||
- Extend perl examples to use more http features [\#479](https://github.com/fission/fission/pull/479) ([LittleFox94](https://github.com/LittleFox94))
|
||||
- Fluentd image tag issue in tests - an additional tag was appended [\#469](https://github.com/fission/fission/pull/469) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Fix broken redirect in python example [\#467](https://github.com/fission/fission/pull/467) ([soamvasani](https://github.com/soamvasani))
|
||||
- Add readiness probe to go env [\#461](https://github.com/fission/fission/pull/461) ([life1347](https://github.com/life1347))
|
||||
- Fix fission bundle build failure [\#456](https://github.com/fission/fission/pull/456) ([life1347](https://github.com/life1347))
|
||||
- Convert build.sh to a multi-stage Dockerfile. [\#452](https://github.com/fission/fission/pull/452) ([justinbarrick](https://github.com/justinbarrick))
|
||||
- NewDeploy Doc [\#432](https://github.com/fission/fission/pull/432) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Add go vet check [\#430](https://github.com/fission/fission/pull/430) ([life1347](https://github.com/life1347))
|
||||
- Fix potential nil pointer problem [\#485](https://github.com/fission/fission/pull/485) ([life1347](https://github.com/life1347))
|
||||
- Add simple usage doc for accessing secret/configmap in function [\#484](https://github.com/fission/fission/pull/484) ([life1347](https://github.com/life1347))
|
||||
- Helm hook bugfixes: run on upgrade, delete on completion [\#473](https://github.com/fission/fission/pull/473) ([soamvasani](https://github.com/soamvasani))
|
||||
- Archive pruner [\#471](https://github.com/fission/fission/pull/471) ([smruthi2187](https://github.com/smruthi2187))
|
||||
- Build and push fluentd image on release; update chart to use that image [\#462](https://github.com/fission/fission/pull/462) ([soamvasani](https://github.com/soamvasani))
|
||||
- Installation instructions for Fission Workflows [\#453](https://github.com/fission/fission/pull/453) ([erwinvaneyk](https://github.com/erwinvaneyk))
|
||||
- Block build requests before environment builder is ready [\#437](https://github.com/fission/fission/pull/437) ([life1347](https://github.com/life1347))
|
||||
- Show warning when user tries to create a function with a non-existed environment [\#436](https://github.com/fission/fission/pull/436) ([life1347](https://github.com/life1347))
|
||||
- Declarative application specifications for Fission [\#422](https://github.com/fission/fission/pull/422) ([soamvasani](https://github.com/soamvasani))
|
||||
- Functions have access to secrets/configmaps specified by the user [\#399](https://github.com/fission/fission/pull/399) ([prithviramesh](https://github.com/prithviramesh))
|
||||
- Newdeploy backend [\#387](https://github.com/fission/fission/pull/387) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
|
||||
## [0.4.1](https://github.com/fission/fission/tree/0.4.1) (2018-01-20)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/0.4.0...0.4.1)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Fix python environment failed to launch [\#451](https://github.com/fission/fission/pull/451) ([life1347](https://github.com/life1347))
|
||||
- use time.Since instead of time.Now\(\).Sub [\#449](https://github.com/fission/fission/pull/449) ([wgliang](https://github.com/wgliang))
|
||||
- Fix fission function logs [\#448](https://github.com/fission/fission/pull/448) ([prithviramesh](https://github.com/prithviramesh))
|
||||
- Integration test improvements [\#447](https://github.com/fission/fission/pull/447) ([soamvasani](https://github.com/soamvasani))
|
||||
- Use storageClassName in Helm Charts \(\#444\) [\#445](https://github.com/fission/fission/pull/445) ([agrahamlincoln](https://github.com/agrahamlincoln))
|
||||
- Fscache support for multiple kubernetes objects [\#435](https://github.com/fission/fission/pull/435) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Improve travi-ci test scripts [\#434](https://github.com/fission/fission/pull/434) ([life1347](https://github.com/life1347))
|
||||
- Fix glide failed to check out github.com/dsnet/compress [\#429](https://github.com/fission/fission/pull/429) ([life1347](https://github.com/life1347))
|
||||
- Golang v2 environment -- runtime and builder [\#427](https://github.com/fission/fission/pull/427) ([soamvasani](https://github.com/soamvasani))
|
||||
- \[Issue 423\] build logs not saved on build error [\#426](https://github.com/fission/fission/pull/426) ([life1347](https://github.com/life1347))
|
||||
- Add support for httproute Host matching [\#425](https://github.com/fission/fission/pull/425) ([ajbouh](https://github.com/ajbouh))
|
||||
- Removed openshift specifics as they are no longer necessary [\#424](https://github.com/fission/fission/pull/424) ([karmab](https://github.com/karmab))
|
||||
- Overwrite request host with internal host to prevent request rejection [\#419](https://github.com/fission/fission/pull/419) ([life1347](https://github.com/life1347))
|
||||
- Fix pool manager crash problem if failed at http call [\#418](https://github.com/fission/fission/pull/418) ([life1347](https://github.com/life1347))
|
||||
- Update nats dependencies [\#411](https://github.com/fission/fission/pull/411) ([life1347](https://github.com/life1347))
|
||||
- Prepare Fission for IPv6 uses [\#408](https://github.com/fission/fission/pull/408) ([valentin2105](https://github.com/valentin2105))
|
||||
- Executor API panics if there is err in getting function from backends [\#407](https://github.com/fission/fission/pull/407) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- fission function logs returns logs in correct order now [\#405](https://github.com/fission/fission/pull/405) ([prithviramesh](https://github.com/prithviramesh))
|
||||
- Fetcher retry [\#403](https://github.com/fission/fission/pull/403) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Add fission/builder image [\#397](https://github.com/fission/fission/pull/397) ([erwinvaneyk](https://github.com/erwinvaneyk))
|
||||
- Changed podName to a generic objectReference in cache implementation [\#391](https://github.com/fission/fission/pull/391) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Add package command [\#385](https://github.com/fission/fission/pull/385) ([life1347](https://github.com/life1347))
|
||||
- Executor abstraction [\#384](https://github.com/fission/fission/pull/384) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
|
||||
## [0.4.0](https://github.com/fission/fission/tree/0.4.0) (2017-11-15)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/0.4.0rc...0.4.0)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Added python example to demonstrate status codes. [\#395](https://github.com/fission/fission/pull/395) ([c0dyhi11](https://github.com/c0dyhi11))
|
||||
- created weather.js in node.js examples, modified README.md [\#394](https://github.com/fission/fission/pull/394) ([svicenteruiz](https://github.com/svicenteruiz))
|
||||
- Delete failed helm releases to prevent test case failure [\#393](https://github.com/fission/fission/pull/393) ([life1347](https://github.com/life1347))
|
||||
- Added AWS to install cloud setup [\#392](https://github.com/fission/fission/pull/392) ([joshkelly](https://github.com/joshkelly))
|
||||
- Fix functionReferenceResolver return out-of-date function metadata [\#390](https://github.com/fission/fission/pull/390) ([life1347](https://github.com/life1347))
|
||||
- changes made to FluentD configuration to circumvent Logger daemonset [\#380](https://github.com/fission/fission/pull/380) ([prithviramesh](https://github.com/prithviramesh))
|
||||
|
||||
## [0.4.0rc](https://github.com/fission/fission/tree/0.4.0rc) (2017-11-08)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/0.3.0...0.4.0rc)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Use store to sync functions/triggers for fast synchronization [\#382](https://github.com/fission/fission/pull/382) ([life1347](https://github.com/life1347))
|
||||
- Switch from ThirdPartyResources to CustomResourceDefinitions [\#381](https://github.com/fission/fission/pull/381) ([life1347](https://github.com/life1347))
|
||||
- changed helm install pullPolicy from Always to IfNotPresent when building local docker image [\#378](https://github.com/fission/fission/pull/378) ([prithviramesh](https://github.com/prithviramesh))
|
||||
- Reduce function resolving time [\#376](https://github.com/fission/fission/pull/376) ([life1347](https://github.com/life1347))
|
||||
- Fix builder manager issues [\#367](https://github.com/fission/fission/pull/367) ([life1347](https://github.com/life1347))
|
||||
- Test functions 236 [\#355](https://github.com/fission/fission/pull/355) ([vishal-biyani](https://github.com/vishal-biyani))
|
||||
- Make default node-env use alpine. List envs in documentation. [\#354](https://github.com/fission/fission/pull/354) ([rapitable](https://github.com/rapitable))
|
||||
- Update k8s client version to 4.0.0 [\#351](https://github.com/fission/fission/pull/351) ([life1347](https://github.com/life1347))
|
||||
|
||||
## [0.3.0](https://github.com/fission/fission/tree/0.3.0) (2017-09-29)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/0.3.0-rc...0.3.0)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- dotnet20 build fixes [\#365](https://github.com/fission/fission/pull/365) ([soamvasani](https://github.com/soamvasani))
|
||||
- Add experimental deploy script [\#364](https://github.com/fission/fission/pull/364) ([erwinvaneyk](https://github.com/erwinvaneyk))
|
||||
- Fix workflow apiserver proxy [\#363](https://github.com/fission/fission/pull/363) ([erwinvaneyk](https://github.com/erwinvaneyk))
|
||||
- Differentiate by environment in fscache eviction [\#361](https://github.com/fission/fission/pull/361) ([soamvasani](https://github.com/soamvasani))
|
||||
|
||||
## [0.3.0-rc](https://github.com/fission/fission/tree/0.3.0-rc) (2017-09-27)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/buildmgr-preview-20170922...0.3.0-rc)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Dump package resources at the end of tests [\#357](https://github.com/fission/fission/pull/357) ([soamvasani](https://github.com/soamvasani))
|
||||
- Use Containers to find matched storage containers \(\#350\) [\#353](https://github.com/fission/fission/pull/353) ([life1347](https://github.com/life1347))
|
||||
- Fix storage service failed to start after restarting it [\#352](https://github.com/fission/fission/pull/352) ([life1347](https://github.com/life1347))
|
||||
- Add bodyparser for text/plain to node-env [\#349](https://github.com/fission/fission/pull/349) ([erwinvaneyk](https://github.com/erwinvaneyk))
|
||||
- Fix unsupported checksum type \(issue 342\) [\#343](https://github.com/fission/fission/pull/343) ([life1347](https://github.com/life1347))
|
||||
- Fission workflow env integration [\#336](https://github.com/fission/fission/pull/336) ([erwinvaneyk](https://github.com/erwinvaneyk))
|
||||
- Add builder manager support [\#308](https://github.com/fission/fission/pull/308) ([life1347](https://github.com/life1347))
|
||||
|
||||
## [buildmgr-preview-20170922](https://github.com/fission/fission/tree/buildmgr-preview-20170922) (2017-09-22)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/buildmgr-preview-20170921...buildmgr-preview-20170922)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Multiple Trigger Definitions Fix [\#341](https://github.com/fission/fission/pull/341) ([jsturtevant](https://github.com/jsturtevant))
|
||||
|
||||
## [buildmgr-preview-20170921](https://github.com/fission/fission/tree/buildmgr-preview-20170921) (2017-09-21)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/v0.2.1...buildmgr-preview-20170921)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Update a dependency in the package.json [\#339](https://github.com/fission/fission/pull/339) ([watilde](https://github.com/watilde))
|
||||
- Fission dotnet 2.0 env [\#337](https://github.com/fission/fission/pull/337) ([joalmeid](https://github.com/joalmeid))
|
||||
- Fix internal route setup bug [\#335](https://github.com/fission/fission/pull/335) ([soamvasani](https://github.com/soamvasani))
|
||||
- Tag and push the latest environment images [\#333](https://github.com/fission/fission/pull/333) ([y-taka-23](https://github.com/y-taka-23))
|
||||
- Function service cache partial support for multiple specialization [\#332](https://github.com/fission/fission/pull/332) ([soamvasani](https://github.com/soamvasani))
|
||||
- Upgrade Node Environment to 8.x [\#329](https://github.com/fission/fission/pull/329) ([MylesBorins](https://github.com/MylesBorins))
|
||||
- Removed deprecated k8s templates [\#327](https://github.com/fission/fission/pull/327) ([erwinvaneyk](https://github.com/erwinvaneyk))
|
||||
- Post-install hook to poke analytics function [\#325](https://github.com/fission/fission/pull/325) ([soamvasani](https://github.com/soamvasani))
|
||||
- update readme with latest install instructions [\#324](https://github.com/fission/fission/pull/324) ([soamvasani](https://github.com/soamvasani))
|
||||
|
||||
## [v0.2.1](https://github.com/fission/fission/tree/v0.2.1) (2017-09-12)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/v0.2.1-rc2...v0.2.1)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Upgrade tool for 0.1 -\> 0.2.1 [\#320](https://github.com/fission/fission/pull/320) ([soamvasani](https://github.com/soamvasani))
|
||||
- Release automation script -- attach helm charts, tag env images [\#318](https://github.com/fission/fission/pull/318) ([soamvasani](https://github.com/soamvasani))
|
||||
|
||||
## [v0.2.1-rc2](https://github.com/fission/fission/tree/v0.2.1-rc2) (2017-09-10)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/v0.2.1-rc...v0.2.1-rc2)
|
||||
|
||||
## [v0.2.1-rc](https://github.com/fission/fission/tree/v0.2.1-rc) (2017-09-09)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/v0.2.0-20170901...v0.2.1-rc)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Hugo-based documentation site [\#317](https://github.com/fission/fission/pull/317) ([soamvasani](https://github.com/soamvasani))
|
||||
- Use latest function metadata to check cached function service. [\#316](https://github.com/fission/fission/pull/316) ([life1347](https://github.com/life1347))
|
||||
- Storage service helm chart integration + bugfixes [\#315](https://github.com/fission/fission/pull/315) ([soamvasani](https://github.com/soamvasani))
|
||||
- Added perl environment [\#311](https://github.com/fission/fission/pull/311) ([LittleFox94](https://github.com/LittleFox94))
|
||||
- Move builds to package level [\#297](https://github.com/fission/fission/pull/297) ([soamvasani](https://github.com/soamvasani))
|
||||
|
||||
## [v0.2.0-20170901](https://github.com/fission/fission/tree/v0.2.0-20170901) (2017-09-01)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/nightly20170705...v0.2.0-20170901)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Large functions: API proxy for storage svc, upload support in the CLI [\#304](https://github.com/fission/fission/pull/304) ([soamvasani](https://github.com/soamvasani))
|
||||
- Unarchive zip file after fetcher downloads the package [\#301](https://github.com/fission/fission/pull/301) ([life1347](https://github.com/life1347))
|
||||
- Storage service and client [\#300](https://github.com/fission/fission/pull/300) ([soamvasani](https://github.com/soamvasani))
|
||||
- Add link to the logs section of INSTALL.md [\#299](https://github.com/fission/fission/pull/299) ([ly798](https://github.com/ly798))
|
||||
- Add Environment v2 Builder [\#298](https://github.com/fission/fission/pull/298) ([life1347](https://github.com/life1347))
|
||||
- Add env builder & srcpkg through cli [\#296](https://github.com/fission/fission/pull/296) ([life1347](https://github.com/life1347))
|
||||
- Split out the Package type into a first class Kubernetes resource [\#295](https://github.com/fission/fission/pull/295) ([soamvasani](https://github.com/soamvasani))
|
||||
- Helm chart bugfixes + end to end test bugfixes [\#293](https://github.com/fission/fission/pull/293) ([soamvasani](https://github.com/soamvasani))
|
||||
- Minor documentation fix for the Go example [\#292](https://github.com/fission/fission/pull/292) ([georgebuckerfield](https://github.com/georgebuckerfield))
|
||||
- Improve error message if an older CLI attempts to make a request [\#291](https://github.com/fission/fission/pull/291) ([rapitable](https://github.com/rapitable))
|
||||
- Update list of environments currently in README [\#289](https://github.com/fission/fission/pull/289) ([erwinvaneyk](https://github.com/erwinvaneyk))
|
||||
- Fix fetcher failed to access TPR if RBAC is enabled [\#288](https://github.com/fission/fission/pull/288) ([life1347](https://github.com/life1347))
|
||||
- Fix bug that causes us to skip our new e2e tests [\#285](https://github.com/fission/fission/pull/285) ([soamvasani](https://github.com/soamvasani))
|
||||
- Parse metadata.Name before creating tpr resource [\#284](https://github.com/fission/fission/pull/284) ([life1347](https://github.com/life1347))
|
||||
- Remove etcd deployment & svc [\#282](https://github.com/fission/fission/pull/282) ([life1347](https://github.com/life1347))
|
||||
- End to end test runner [\#281](https://github.com/fission/fission/pull/281) ([soamvasani](https://github.com/soamvasani))
|
||||
- Set fetcher image through poolmgr env [\#280](https://github.com/fission/fission/pull/280) ([life1347](https://github.com/life1347))
|
||||
- Set message content-type based on the trigger.Spec.ContentType [\#279](https://github.com/fission/fission/pull/279) ([life1347](https://github.com/life1347))
|
||||
- Helm chart updates [\#273](https://github.com/fission/fission/pull/273) ([soamvasani](https://github.com/soamvasani))
|
||||
- Kubernetes access for Travis CI tests [\#272](https://github.com/fission/fission/pull/272) ([soamvasani](https://github.com/soamvasani))
|
||||
- V2 types and TPR [\#266](https://github.com/fission/fission/pull/266) ([soamvasani](https://github.com/soamvasani))
|
||||
- Fix logger prints wrong log [\#263](https://github.com/fission/fission/pull/263) ([life1347](https://github.com/life1347))
|
||||
- Fix nats trigger replies message to non-existing response topic [\#260](https://github.com/fission/fission/pull/260) ([life1347](https://github.com/life1347))
|
||||
- Binary Environment [\#256](https://github.com/fission/fission/pull/256) ([erwinvaneyk](https://github.com/erwinvaneyk))
|
||||
- fix typo funtion -\> function [\#252](https://github.com/fission/fission/pull/252) ([sbfaulkner](https://github.com/sbfaulkner))
|
||||
- Ruby logger [\#251](https://github.com/fission/fission/pull/251) ([sbfaulkner](https://github.com/sbfaulkner))
|
||||
- Update/Add fission-core & fission-all helm charts [\#239](https://github.com/fission/fission/pull/239) ([life1347](https://github.com/life1347))
|
||||
- Fix unstoppable kubewatcher [\#208](https://github.com/fission/fission/pull/208) ([life1347](https://github.com/life1347))
|
||||
|
||||
## [nightly20170705](https://github.com/fission/fission/tree/nightly20170705) (2017-07-06)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/nightly20170621...nightly20170705)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- include path parameters in params hash for ruby environment [\#249](https://github.com/fission/fission/pull/249) ([sbfaulkner](https://github.com/sbfaulkner))
|
||||
- Fission update must require at least one change to function [\#241](https://github.com/fission/fission/pull/241) ([life1347](https://github.com/life1347))
|
||||
- Add message queue trigger support [\#218](https://github.com/fission/fission/pull/218) ([life1347](https://github.com/life1347))
|
||||
|
||||
## [nightly20170621](https://github.com/fission/fission/tree/nightly20170621) (2017-06-21)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/alpha20170124...nightly20170621)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Fix creating redundant pods on heavyload coldstart [\#232](https://github.com/fission/fission/pull/232) ([yqf3139](https://github.com/yqf3139))
|
||||
- Aggregate tap service request in interval [\#229](https://github.com/fission/fission/pull/229) ([yqf3139](https://github.com/yqf3139))
|
||||
- Specify full golang version in Dockerfiles and build helper script [\#227](https://github.com/fission/fission/pull/227) ([soamvasani](https://github.com/soamvasani))
|
||||
- Retrieve URL params in functions \(\#158\) [\#226](https://github.com/fission/fission/pull/226) ([yqf3139](https://github.com/yqf3139))
|
||||
- Fix s/Sirupsen/sirupsen/ for logrus [\#224](https://github.com/fission/fission/pull/224) ([n1koo](https://github.com/n1koo))
|
||||
- add ruby-env [\#223](https://github.com/fission/fission/pull/223) ([sbfaulkner](https://github.com/sbfaulkner))
|
||||
- Fix pool contains wrong environment metadata [\#221](https://github.com/fission/fission/pull/221) ([life1347](https://github.com/life1347))
|
||||
- Added support for pods and replication controllers to watchers [\#216](https://github.com/fission/fission/pull/216) ([javierbq](https://github.com/javierbq))
|
||||
- Fix two links in Roadmap doc [\#213](https://github.com/fission/fission/pull/213) ([markpeek](https://github.com/markpeek))
|
||||
- Fix http response body not closed correctly & return immediately when error occurred [\#210](https://github.com/fission/fission/pull/210) ([life1347](https://github.com/life1347))
|
||||
- Print log when timetrigger is removed [\#209](https://github.com/fission/fission/pull/209) ([life1347](https://github.com/life1347))
|
||||
- Retrieve function logs from controller [\#207](https://github.com/fission/fission/pull/207) ([life1347](https://github.com/life1347))
|
||||
- Adding fission-rbac.yml for [\#183](https://github.com/fission/fission/pull/183) ([gamefiend](https://github.com/gamefiend))
|
||||
- Add OpenShift INSTALL.md docs [\#179](https://github.com/fission/fission/pull/179) ([tiny-dancer](https://github.com/tiny-dancer))
|
||||
- Lighten up the python3 base image \(alpine\) [\#171](https://github.com/fission/fission/pull/171) ([syassami](https://github.com/syassami))
|
||||
- Make the chart work with helm 2.2 [\#170](https://github.com/fission/fission/pull/170) ([apenney](https://github.com/apenney))
|
||||
- Add OpenShift support \(\#107\) [\#168](https://github.com/fission/fission/pull/168) ([methadata](https://github.com/methadata))
|
||||
- Go build helper script [\#163](https://github.com/fission/fission/pull/163) ([soamvasani](https://github.com/soamvasani))
|
||||
- Add Time Trigger API and client \(\#153\) [\#161](https://github.com/fission/fission/pull/161) ([yqf3139](https://github.com/yqf3139))
|
||||
- Add fission-ui intro in readme [\#159](https://github.com/fission/fission/pull/159) ([yqf3139](https://github.com/yqf3139))
|
||||
- Drop Go 1.7, use Go 1.8 [\#157](https://github.com/fission/fission/pull/157) ([soamvasani](https://github.com/soamvasani))
|
||||
- Add README for Node.js examples [\#155](https://github.com/fission/fission/pull/155) ([RobertHerhold](https://github.com/RobertHerhold))
|
||||
- Upgrade node environment to Node.js 7.6.0+ [\#151](https://github.com/fission/fission/pull/151) ([RobertHerhold](https://github.com/RobertHerhold))
|
||||
- use fmt.Errorf instead of error.New\(\) [\#149](https://github.com/fission/fission/pull/149) ([maxwell92](https://github.com/maxwell92))
|
||||
- Return 201 for created resources [\#148](https://github.com/fission/fission/pull/148) ([RobertHerhold](https://github.com/RobertHerhold))
|
||||
- Set correct Content-Type in the http response [\#147](https://github.com/fission/fission/pull/147) ([lingxiankong](https://github.com/lingxiankong))
|
||||
- Make it more clear where to clone this repo [\#145](https://github.com/fission/fission/pull/145) ([RobertHerhold](https://github.com/RobertHerhold))
|
||||
- Fix function delete with uid [\#142](https://github.com/fission/fission/pull/142) ([yqf3139](https://github.com/yqf3139))
|
||||
- Fixed pod has no ip \(\#139\) [\#141](https://github.com/fission/fission/pull/141) ([life1347](https://github.com/life1347))
|
||||
- fix\(kubeEventsSlack\): typo and wrong variable name [\#140](https://github.com/fission/fission/pull/140) ([Pindar](https://github.com/Pindar))
|
||||
- Ignore the vendor folder [\#137](https://github.com/fission/fission/pull/137) ([RobertHerhold](https://github.com/RobertHerhold))
|
||||
- Fix Markdown table [\#136](https://github.com/fission/fission/pull/136) ([RobertHerhold](https://github.com/RobertHerhold))
|
||||
- Symlink user function's node\_modules to server's node\_modules [\#133](https://github.com/fission/fission/pull/133) ([soamvasani](https://github.com/soamvasani))
|
||||
- Add function logs support \(\#53\) [\#131](https://github.com/fission/fission/pull/131) ([life1347](https://github.com/life1347))
|
||||
- Remove redundant hello.js from charts directory [\#130](https://github.com/fission/fission/pull/130) ([ssudake21](https://github.com/ssudake21))
|
||||
- Handle errors in filestore init \(\#108\) [\#127](https://github.com/fission/fission/pull/127) ([soamvasani](https://github.com/soamvasani))
|
||||
- \[WIP\] Golang runtime [\#125](https://github.com/fission/fission/pull/125) ([nouney](https://github.com/nouney))
|
||||
- Modify the stock example to show how to change the Content-Type [\#124](https://github.com/fission/fission/pull/124) ([gonrial](https://github.com/gonrial))
|
||||
- Improve command-line client error output [\#122](https://github.com/fission/fission/pull/122) ([tobias](https://github.com/tobias))
|
||||
- Report KeyNotFound from etcd as a 404 [\#121](https://github.com/fission/fission/pull/121) ([tobias](https://github.com/tobias))
|
||||
- Use latest for stable release of minikube [\#120](https://github.com/fission/fission/pull/120) ([r2d4](https://github.com/r2d4))
|
||||
- Fixed failed to delete function when function's file is not exist [\#118](https://github.com/fission/fission/pull/118) ([life1347](https://github.com/life1347))
|
||||
- Update gitignore to include dev artifacts [\#117](https://github.com/fission/fission/pull/117) ([tobias](https://github.com/tobias))
|
||||
- Better convey duplicate name errors to client [\#116](https://github.com/fission/fission/pull/116) ([tobias](https://github.com/tobias))
|
||||
- Don't wait for ready pod in MakeGenericPool [\#114](https://github.com/fission/fission/pull/114) ([soamvasani](https://github.com/soamvasani))
|
||||
- Allow unique HTTP route & method \(\#102\) [\#111](https://github.com/fission/fission/pull/111) ([kphatak](https://github.com/kphatak))
|
||||
- Minor improvements to build instructions in README [\#110](https://github.com/fission/fission/pull/110) ([tobias](https://github.com/tobias))
|
||||
- Make build an actual sh script [\#109](https://github.com/fission/fission/pull/109) ([tobias](https://github.com/tobias))
|
||||
- Fixing validations of fn actions [\#106](https://github.com/fission/fission/pull/106) ([kphatak](https://github.com/kphatak))
|
||||
- Http request support [\#105](https://github.com/fission/fission/pull/105) ([ktrance](https://github.com/ktrance))
|
||||
- function code download using HTTP URL [\#100](https://github.com/fission/fission/pull/100) ([kphatak](https://github.com/kphatak))
|
||||
- Error when env name/image not provided [\#98](https://github.com/fission/fission/pull/98) ([lcrisci](https://github.com/lcrisci))
|
||||
- Add initial support for PHP7 [\#97](https://github.com/fission/fission/pull/97) ([dgoujard](https://github.com/dgoujard))
|
||||
- kubewatcher example: send watch updates to slack [\#96](https://github.com/fission/fission/pull/96) ([soamvasani](https://github.com/soamvasani))
|
||||
- bugfix \(cli\) Update the URL check to work with https [\#94](https://github.com/fission/fission/pull/94) ([andrewstuart](https://github.com/andrewstuart))
|
||||
- Primary Helm chart for fission [\#90](https://github.com/fission/fission/pull/90) ([ssudake21](https://github.com/ssudake21))
|
||||
- Wait for Pod IP while waiting for pod ready [\#89](https://github.com/fission/fission/pull/89) ([soamvasani](https://github.com/soamvasani))
|
||||
- Added support for running C\# code in a dotnet core environment [\#84](https://github.com/fission/fission/pull/84) ([ktrance](https://github.com/ktrance))
|
||||
|
||||
## [alpha20170124](https://github.com/fission/fission/tree/alpha20170124) (2017-01-24)
|
||||
[Full Changelog](https://github.com/fission/fission/compare/kubecon...alpha20170124)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Make go vet happy [\#87](https://github.com/fission/fission/pull/87) ([AlekSi](https://github.com/AlekSi))
|
||||
- Ignore glide cache in gofmt check [\#86](https://github.com/fission/fission/pull/86) ([soamvasani](https://github.com/soamvasani))
|
||||
- Bugfix for internal routes [\#81](https://github.com/fission/fission/pull/81) ([soamvasani](https://github.com/soamvasani))
|
||||
- Bug fix for handling a route's HTTP method in router [\#79](https://github.com/fission/fission/pull/79) ([soamvasani](https://github.com/soamvasani))
|
||||
- fission-bundle: allow setting the namespace [\#77](https://github.com/fission/fission/pull/77) ([frodenas](https://github.com/frodenas))
|
||||
- Delete generic pools when environments are deleted [\#75](https://github.com/fission/fission/pull/75) ([soamvasani](https://github.com/soamvasani))
|
||||
- Poolmgr: fix pod leak bugs on specializePod failure [\#70](https://github.com/fission/fission/pull/70) ([soamvasani](https://github.com/soamvasani))
|
||||
- Poolmgr: ensure orphaned resources are cleaned up [\#69](https://github.com/fission/fission/pull/69) ([soamvasani](https://github.com/soamvasani))
|
||||
- Implement 'fission route update' [\#68](https://github.com/fission/fission/pull/68) ([soamvasani](https://github.com/soamvasani))
|
||||
- Update router cache on new function version [\#67](https://github.com/fission/fission/pull/67) ([soamvasani](https://github.com/soamvasani))
|
||||
- Changed Package Names to Match new Github Organization [\#66](https://github.com/fission/fission/pull/66) ([jgavinray](https://github.com/jgavinray))
|
||||
- Add HTTP route create params to function create command [\#65](https://github.com/fission/fission/pull/65) ([soamvasani](https://github.com/soamvasani))
|
||||
- Add kubectl download to install instructions [\#61](https://github.com/fission/fission/pull/61) ([soamvasani](https://github.com/soamvasani))
|
||||
- Readme minikube instructions [\#60](https://github.com/fission/fission/pull/60) ([soamvasani](https://github.com/soamvasani))
|
||||
- Check for name in 'function delete' [\#59](https://github.com/fission/fission/pull/59) ([soamvasani](https://github.com/soamvasani))
|
||||
- adding go-report card and fixing minor typo in README [\#57](https://github.com/fission/fission/pull/57) ([kphatak](https://github.com/kphatak))
|
||||
- Kubewatcher: trigger functions from Kubernetes Watch callbacks [\#56](https://github.com/fission/fission/pull/56) ([soamvasani](https://github.com/soamvasani))
|
||||
- adding commonly used python libraries [\#49](https://github.com/fission/fission/pull/49) ([kphatak](https://github.com/kphatak))
|
||||
- Setup app.logger for python environment [\#48](https://github.com/fission/fission/pull/48) ([soamvasani](https://github.com/soamvasani))
|
||||
- Add build badge [\#46](https://github.com/fission/fission/pull/46) ([soamvasani](https://github.com/soamvasani))
|
||||
- Install and run etcd on travis [\#45](https://github.com/fission/fission/pull/45) ([soamvasani](https://github.com/soamvasani))
|
||||
- Bugfix in functionServiceCache test [\#44](https://github.com/fission/fission/pull/44) ([soamvasani](https://github.com/soamvasani))
|
||||
- Fix cache test [\#43](https://github.com/fission/fission/pull/43) ([soamvasani](https://github.com/soamvasani))
|
||||
- \#25 Continuous Testing [\#42](https://github.com/fission/fission/pull/42) ([jgavinray](https://github.com/jgavinray))
|
||||
- add travis integration test [\#41](https://github.com/fission/fission/pull/41) ([carmark](https://github.com/carmark))
|
||||
- Fix `environment` command typo. [\#39](https://github.com/fission/fission/pull/39) ([pirogoeth](https://github.com/pirogoeth))
|
||||
- Edit readme [\#38](https://github.com/fission/fission/pull/38) ([soamvasani](https://github.com/soamvasani))
|
||||
- Updated README to include protocol scheme for FISSION\_URL prefix [\#36](https://github.com/fission/fission/pull/36) ([efexen](https://github.com/efexen))
|
||||
- Add minikube example in readme [\#34](https://github.com/fission/fission/pull/34) ([johscheuer](https://github.com/johscheuer))
|
||||
- README: use kubectl create -f http [\#32](https://github.com/fission/fission/pull/32) ([philips](https://github.com/philips))
|
||||
- Python environment improvements [\#30](https://github.com/fission/fission/pull/30) ([soamvasani](https://github.com/soamvasani))
|
||||
- Readme updates [\#29](https://github.com/fission/fission/pull/29) ([soamvasani](https://github.com/soamvasani))
|
||||
- Add "fission function edit \<function\>" command [\#28](https://github.com/fission/fission/pull/28) ([soamvasani](https://github.com/soamvasani))
|
||||
- Move client-go dependency to 1.5 [\#27](https://github.com/fission/fission/pull/27) ([soamvasani](https://github.com/soamvasani))
|
||||
|
||||
## [kubecon](https://github.com/fission/fission/tree/kubecon) (2016-11-11)
|
||||
**Merged pull requests:**
|
||||
|
||||
- Reap idle pods [\#20](https://github.com/fission/fission/pull/20) ([soamvasani](https://github.com/soamvasani))
|
||||
- Fission CLI [\#19](https://github.com/fission/fission/pull/19) ([soamvasani](https://github.com/soamvasani))
|
||||
- Fix resource store errors on empty db [\#18](https://github.com/fission/fission/pull/18) ([soamvasani](https://github.com/soamvasani))
|
||||
- fission-bundle: executable package for router, controller, poolmgr [\#17](https://github.com/fission/fission/pull/17) ([soamvasani](https://github.com/soamvasani))
|
||||
- Router integration with poolmgr and controller [\#16](https://github.com/fission/fission/pull/16) ([soamvasani](https://github.com/soamvasani))
|
||||
- Poolmgr -- manage generic containers and their specialization [\#15](https://github.com/fission/fission/pull/15) ([soamvasani](https://github.com/soamvasani))
|
||||
- Fetcher is a helper for function run containers [\#14](https://github.com/fission/fission/pull/14) ([soamvasani](https://github.com/soamvasani))
|
||||
- Cache -- simple threadsafe map [\#13](https://github.com/fission/fission/pull/13) ([soamvasani](https://github.com/soamvasani))
|
||||
- Change controller and router exports to make them usable as libraries [\#12](https://github.com/fission/fission/pull/12) ([soamvasani](https://github.com/soamvasani))
|
||||
- Add API version to URLs [\#11](https://github.com/fission/fission/pull/11) ([soamvasani](https://github.com/soamvasani))
|
||||
- Nodejs improvements [\#10](https://github.com/fission/fission/pull/10) ([soamvasani](https://github.com/soamvasani))
|
||||
- Base64 encode the code in json objects. [\#9](https://github.com/fission/fission/pull/9) ([soamvasani](https://github.com/soamvasani))
|
||||
- API for environments [\#8](https://github.com/fission/fission/pull/8) ([soamvasani](https://github.com/soamvasani))
|
||||
- Add HTTP trigger API and client [\#7](https://github.com/fission/fission/pull/7) ([soamvasani](https://github.com/soamvasani))
|
||||
- Move some fission structs to top level package [\#6](https://github.com/fission/fission/pull/6) ([soamvasani](https://github.com/soamvasani))
|
||||
- Controller [\#5](https://github.com/fission/fission/pull/5) ([soamvasani](https://github.com/soamvasani))
|
||||
- Move packages to root dir from src/ [\#4](https://github.com/fission/fission/pull/4) ([soamvasani](https://github.com/soamvasani))
|
||||
- Router [\#3](https://github.com/fission/fission/pull/3) ([soamvasani](https://github.com/soamvasani))
|
||||
- NodeJS Function Run Container [\#2](https://github.com/fission/fission/pull/2) ([soamvasani](https://github.com/soamvasani))
|
||||
- Initial docs commit [\#1](https://github.com/fission/fission/pull/1) ([soamvasani](https://github.com/soamvasani))
|
||||
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ minikube, you'll need to set the proper environment variables with
|
||||
|
||||
```
|
||||
# Get dependencies
|
||||
$ glide install
|
||||
$ glide install -v
|
||||
|
||||
# Build fission server and an image
|
||||
$ pushd fission-bundle
|
||||
@@ -41,7 +41,7 @@ minikube and its built-in docker daemon:
|
||||
Next, install fission with this image on your kubernetes cluster using the helm chart:
|
||||
|
||||
```
|
||||
$ helm install --set "image=minikube/fission-bundle,pullPolicy=IfNotPresent,analytics=false" charts/fission-all
|
||||
$ helm install --set "image=minikube/fission-bundle,imageTag=latest,pullPolicy=IfNotPresent,analytics=false" charts/fission-all
|
||||
```
|
||||
|
||||
And if you're changing the CLI too, you can build it with:
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# Fission Documentation Website
|
||||
|
||||
## Development
|
||||
|
||||
* [Hugo Installation Guide](https://gohugo.io/getting-started/installing/)
|
||||
* Local Preview
|
||||
|
||||
```
|
||||
$ hugo server --buildDrafts --disableFastRender
|
||||
```
|
||||
|
||||
@@ -1,4 +1,35 @@
|
||||
baseURL = "http://fission.io/docs/0.3.0"
|
||||
languageCode = "en-us"
|
||||
baseURL = "http://fission.io/docs/0.6.1"
|
||||
languageCode = "en-US"
|
||||
defaultContentLanguage = "en"
|
||||
|
||||
title = "Fission: Serverless Functions for Kubernetes"
|
||||
theme = "docdock"
|
||||
theme = "learn"
|
||||
metaDataFormat = "yaml"
|
||||
defaultContentLanguageInSubdir= true
|
||||
|
||||
[params]
|
||||
editURL = "https://github.com/fission/fission/edit/master/Documentation/docs-site/content/"
|
||||
description = "Documentation for Fission"
|
||||
author = "Fission"
|
||||
showVisitedLinks = false
|
||||
themeVariant = "fission"
|
||||
|
||||
[outputs]
|
||||
home = [ "HTML", "RSS", "JSON"]
|
||||
|
||||
[Languages]
|
||||
[Languages.en]
|
||||
title = "Serverless Functions for Kubernetes"
|
||||
weight = 1
|
||||
languageName = "English"
|
||||
|
||||
[[Languages.en.menu.shortcuts]]
|
||||
name = "<i class='fa fa-fw fa-github'></i> Github repo"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/fission/fission"
|
||||
weight = 10
|
||||
|
||||
[[Languages.en.menu.shortcuts]]
|
||||
name = "<i class='fa fa-fw fa-bullhorn'></i> Credits"
|
||||
url = "https://github.com/fission/fission/graphs/contributors"
|
||||
weight = 11
|
||||
|
||||
@@ -0,0 +1,99 @@
|
||||
---
|
||||
title: Fission
|
||||
weight: 1
|
||||
---
|
||||
|
||||
Fission: Serverless Functions for Kubernetes
|
||||
============================================
|
||||
|
||||
[fission.io](http://fission.io) [@fissionio](http://twitter.com/fissionio)
|
||||
|
||||
Fission is a fast serverless framework for Kubernetes with a focus on
|
||||
developer productivity and high performance.
|
||||
|
||||
Fission operates on _just the code_: Docker and Kubernetes are
|
||||
abstracted away under normal operation, though you can use both to
|
||||
extend Fission if you want to.
|
||||
|
||||
Fission is extensible to any language; the core is written in Go, and
|
||||
language-specific parts are isolated in something called
|
||||
_environments_ (more below). Fission currently supports NodeJS, Python, Ruby, Go,
|
||||
PHP, Bash, and any Linux executable, with more languages coming soon.
|
||||
|
||||
### Performance: 100msec cold start
|
||||
|
||||
Fission maintains a pool of "warm" containers that each contain a
|
||||
small dynamic loader. When a function is first called,
|
||||
i.e. "cold-started", a running container is chosen and the function is
|
||||
loaded. This pool is what makes Fission fast: cold-start latencies
|
||||
are typically about 100msec.
|
||||
|
||||
### Kubernetes is the right place for Serverless
|
||||
|
||||
We're built on Kubernetes because we think any non-trivial app will
|
||||
use a combination of serverless functions and more conventional
|
||||
microservices, and Kubernetes is a great framework to bring these
|
||||
together seamlessly.
|
||||
|
||||
Building on Kubernetes also means that anything you do for operations
|
||||
on your Kubernetes cluster — such as monitoring or log
|
||||
aggregation — also helps with ops on your Fission deployment.
|
||||
|
||||
|
||||
Fission Concepts
|
||||
----------------
|
||||
|
||||
A _function_ is a piece of code that follows the fission function
|
||||
interface.
|
||||
|
||||
An _environment_ contains the language- and runtime-specific parts of
|
||||
running a function.
|
||||
|
||||
The following environments are currently available:
|
||||
|
||||
|
||||
| Environment | Image |
|
||||
| ------------------------------------ | ------------------------- |
|
||||
| Binary (for executables or scripts) | `fission/binary-env` |
|
||||
| Go | `fission/go-env` |
|
||||
| .NET | `fission/dotnet-env` |
|
||||
| .NET 2.0 | `fission/dotnet20-env` |
|
||||
| NodeJS (Alpine) | `fission/node-env` |
|
||||
| NodeJS (Debian) | `fission/node-env-debian` |
|
||||
| Perl | `fission/perl-env` |
|
||||
| PHP 7 | `fission/php-env` |
|
||||
| Python 3 | `fission/python-env` |
|
||||
| Ruby | `fission/ruby-env` |
|
||||
|
||||
|
||||
You can also extend environments or create entirely new
|
||||
ones if you want. (An environment is essentially just a container
|
||||
with a webserver and dynamic loader.)
|
||||
|
||||
A _trigger_ is something that maps an event to a function; Fission
|
||||
supports HTTP routes as triggers today, with upcoming support for
|
||||
other types of event triggers, such as timers and Kubernetes events.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
```bash
|
||||
|
||||
# Add the stock NodeJS env to your Fission deployment
|
||||
$ fission env create --name nodejs --image fission/node-env
|
||||
|
||||
# A javascript one-liner that prints "hello world"
|
||||
$ curl https://raw.githubusercontent.com/fission/fission/master/examples/nodejs/hello.js > hello.js
|
||||
|
||||
# Upload your function code to fission
|
||||
$ fission function create --name hello --env nodejs --code hello.js
|
||||
|
||||
# Map GET /hello to your new function
|
||||
$ fission route create --method GET --url /hello --function hello
|
||||
|
||||
# Run the function. This takes about 100msec the first time.
|
||||
$ fission function test --name hello
|
||||
Hello, world!
|
||||
```
|
||||
|
||||
See the [examples](examples) directory for more.
|
||||
@@ -1,6 +0,0 @@
|
||||
## Fission Documentation
|
||||
|
||||
* [Installation guide](install)
|
||||
|
||||
* [Upgrade guide for v0.3 to v0.4](upgrade-from-v0.3)
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: "Fission Concepts"
|
||||
chapter: true
|
||||
draft: false
|
||||
weight: 30
|
||||
---
|
||||
|
||||
# Fission Concepts
|
||||
|
||||
This is an overview of the few main concepts in Fission: Functions,
|
||||
Environments, and Triggers.
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "Environments"
|
||||
draft: false
|
||||
weight: 32
|
||||
---
|
||||
|
||||
An environment contains the language and runtime specific parts of a function. An environment is essentially a container with a webserver and a dynamic loader for the function code.
|
||||
|
||||
The following pre-built environments are currently available for use in Fission:
|
||||
|
||||
| Environment | Image |
|
||||
| ------------------------------------ | ------------------------- |
|
||||
| Binary (for executables or scripts) | `fission/binary-env` |
|
||||
| Go | `fission/go-env` |
|
||||
| .NET | `fission/dotnet-env` |
|
||||
| .NET 2.0 | `fission/dotnet20-env` |
|
||||
| NodeJS (Alpine) | `fission/node-env` |
|
||||
| NodeJS (Debian) | `fission/node-env-debian` |
|
||||
| Perl | `fission/perl-env` |
|
||||
| PHP 7 | `fission/php-env` |
|
||||
| Python 3 | `fission/python-env` |
|
||||
| Ruby | `fission/ruby-env` |
|
||||
|
||||
To create custom environments you can extend one of the environments in the list or create your own environment from scratch.
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "Controlling Function Execution"
|
||||
draft: false
|
||||
weight: 33
|
||||
---
|
||||
# Executors
|
||||
|
||||
When you create a function, you can specify an executor for a function. An executor controls how function pods are created and what capabilities are available for that executor type.
|
||||
|
||||
## Pool-based executor
|
||||
|
||||
A pool based executor (Refered to as poolmgr) creates a pool of generic environment pods as soon as you create an environment. The pool size of initial "warm" containers can be configured based on user needs. These warm containers contain a small dynamic loader for loading the function. Resource requirements are specified at environment level and are inherited by specialized function pods.
|
||||
|
||||
Once you create a function and invoke it, one of pods from the pool is taken out and "specialized" and used for execution. This pod is used for subseqnent requests for that function. If there are no more requests for a certain idle duration, then this pod is cleaned up. If a new requests come after the earlier specialized pod was cleaned up, then a new pod is specialised from the pool and used for execution.
|
||||
|
||||
Poolmgr executortype is great for functions where lower latency is a requirement. Poolmgr executortype has certain limitations: for example, you can not autoscale them based on demand.
|
||||
|
||||
|
||||
## New-deployment executor
|
||||
|
||||
New-Deployment executor (Newdeploy) creates a Kubernetes Deployment along with a Service and HorizontalPodAutoscaler for function execution. This enables autoscaling of function pods and load balancing the requests between pods. In future additional capabilities will be added for newdeploy executortype such as support for volume etc. In the new-deploy executor, resource requirements can be specified at the function level. These requirements override those specified in the environment.
|
||||
|
||||
Newdeploy executortype can be used for requests with no particular low-latency requirements, such as those invoked asynchronously, minscale can be set to zero. In this case the Kubernetes deployment and other objects will be created on first invocation of the function. Subsequent requests can be served by the same deployment. If there are no requests for certain duration then the idle objects are cleaned up. This mechanism ensures resource consumption only on demand and is a good fit for asynchronous requests.
|
||||
|
||||
For requests where latency requirements are stringent, a minscale greater than zero can be set. This essentially keeps a minscale number of pods ready when you create a function. When the function is invoked, there is no delay since the pod is already created. Also minscale ensures that the pods are not cleaned up even if the function is idle. This is great for functions where lower latency is more important than saving resource consumption when functions are idle.
|
||||
|
||||
### The latency vs. idle-cost tradeoff
|
||||
|
||||
The executors allow you as a user to decide between latency and a small idle cost tradeoff. Depending on the need you can choose one of the combinations which is optimal for your use case. In future, a more intelligent dispatch mechanism will enable more complex combinations of executors.
|
||||
|
||||
| Executor Type | Min Scale| Latency | Idle cost |
|
||||
|:---------|:---------:|:---------:|:---------|
|
||||
|Newdeploy|0|High|Very low - pods get cleaned up after idlle time|
|
||||
|Newdeploy|>0|Low|Medium, Min Scale number of pods are always up|
|
||||
|Poolmgr|0|Low|Low, pool of pods are always up|
|
||||
|
||||
### Autoscaling
|
||||
|
||||
The new deployment based executor provides autoscaling for functions based on CPU usage. In future custom metrics will be also supported for scaling the functions. You can set the intial and maximum CPU for a function and target CPU at which autoscaling will be trigerred. Autoscaling is useful for workloads where you expect intermittant spikes in workloads. It also enables optimal usage of resources to execute functions, by using a baseline capacity with minimum scale and ability to burst up to maximum scale based on spikes in demand.
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: "Function"
|
||||
draft: true
|
||||
weight: 31
|
||||
---
|
||||
A function is a piece of code that will be invoked based on a [trigger](../trigger). The code follows the Fission interface. In practice, the function is only an entry point for execution and it can be backed by a larger program or module.
|
||||
|
||||
A function is registered with Fission through a CLI and associated with a trigger. A function can be created based on a single source file or a source archive or a deployment archive.
|
||||
|
||||
It is possible to associate and use Kubernetes secrets and configmaps with a function.
|
||||
|
||||
Functions also accept minimum and maximum CPU and memory to be assigned, the behaviour of which varies based on executor types which are discussed in greater detail [here](../executor)
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: "Builder and Packages"
|
||||
draft: false
|
||||
weight: 36
|
||||
---
|
||||
|
||||
Most real world applications are more than a single file of code and typically have dependencies on libraries etc. Packages in fission solve three distinct problems:
|
||||
|
||||
1) Enable a mechanism to store more than one file as a single unit and use them with functions. This is done through a combination of deployment archive builder environment associated with the environment.
|
||||
|
||||
2) Provide a mechanism to build from source code and dependencies into a binary based on a build command and store it as an object. User should be able to use this built artifact with a function. This is achieved with a source archive and a builder environment.
|
||||
|
||||
3) Decouple the execution logic from the functions and thus enable reuse of same logic for multiple functions. This will enable user to run same logic with different functions having different runtime charateristics and executor types.
|
||||
|
||||
When you create a function with a single source file, fission internally creates a package and links it to a function. Creating a package explicitly gives more flexibility in some use cases as explained above.
|
||||
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: "Trigger"
|
||||
draft: false
|
||||
weight: 34
|
||||
---
|
||||
|
||||
Triggers are events that can invoke a [function](../function). Fission has three kinds of triggers that can be used to invoke functions.
|
||||
|
||||
## Http Trigger
|
||||
|
||||
HTTP triggers enable calling functions with HTTP requests. Supported methods are GET, POST, PUT, DELETE, HEAD and by default GET is used. URL pattern follow the gorilla/mux supported patterns.
|
||||
|
||||
## Time Trigger
|
||||
|
||||
If you want a function to be called at a periodic frequency then the time triggers are perfect for the use case. Time triggers follow cron like specifications and are invoked based on the cron schedule.
|
||||
|
||||
Time trigger based invocations are great for running scheduled jobs, periodic cleanup jobs, periodic polling based invocations etc.
|
||||
|
||||
## MQ Trigger
|
||||
|
||||
Message queue based trigger enables ability to listen on a topic and invoke a function for each message. You can optinally send a response to another topic. By default it is assumed that the messages in queue are in application/json format but you can specify otherwise while creating the trigger. Currently `nats-streaming` and `azure-storage-queue` are supported message queues supported.
|
||||
|
||||
MQ triggers are great for integrating various systems in a decoupled and asynchronous manner.
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "Contributing to Fission"
|
||||
draft: false
|
||||
weight: 50
|
||||
chapter: true
|
||||
---
|
||||
|
||||
# Contributing to Fission
|
||||
|
||||
### Development guide
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
title: "Compiling Fission"
|
||||
date: 2017-09-07T20:10:05-07:00
|
||||
draft: false
|
||||
weight: 51
|
||||
---
|
||||
|
||||
[You only need to do this if you're making Fission changes; if you're
|
||||
just deploying Fission, use fission.yaml which points to prebuilt
|
||||
images.]
|
||||
|
||||
You'll need the `go` compiler and tools installed, along with the
|
||||
[glide dependency management
|
||||
tool](https://github.com/Masterminds/glide#install). You'll also need
|
||||
docker for building images.
|
||||
|
||||
The server side is compiled as one binary ("fission-bundle") which
|
||||
contains controller, poolmgr and router; it invokes the right one
|
||||
based on command-line arguments.
|
||||
|
||||
To build fission-bundle: clone this repo to
|
||||
`$GOPATH/src/github.com/fission/fission`, then from the top level
|
||||
directory (if you want to build the image with the docker inside
|
||||
minikube, you'll need to set the proper environment variables with
|
||||
`eval $(minikube docker-env)`):
|
||||
|
||||
```
|
||||
# Get dependencies
|
||||
$ glide install
|
||||
|
||||
# Build fission server and an image
|
||||
$ pushd fission-bundle
|
||||
$ ./build.sh
|
||||
```
|
||||
|
||||
You now need to build the docker image for fission. You can use
|
||||
`push.sh` and push it to a docker hub account. But it's easiest to use
|
||||
minikube and its built-in docker daemon:
|
||||
|
||||
```
|
||||
$ eval $(minikube docker-env)
|
||||
$ docker build -t minikube/fission-bundle .
|
||||
```
|
||||
|
||||
Next, install fission with this image on your kubernetes cluster using the helm chart:
|
||||
|
||||
```
|
||||
$ helm install --set "image=minikube/fission-bundle,pullPolicy=IfNotPresent,analytics=false" charts/fission-all
|
||||
```
|
||||
|
||||
And if you're changing the CLI too, you can build it with:
|
||||
|
||||
```
|
||||
# Build Fission CLI
|
||||
$ cd fission && go install
|
||||
```
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "Installation Guide"
|
||||
draft: false
|
||||
weight: 20
|
||||
chapter : true
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
### Installing and upgrading Fission
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Fission Installation Guide"
|
||||
date: 2017-09-07T20:10:05-07:00
|
||||
title: "Installation Guide"
|
||||
draft: false
|
||||
weight: 20
|
||||
---
|
||||
|
||||
Welcome! This guide will get you up and running with Fission on a
|
||||
@@ -20,19 +20,19 @@ ready. If you already have helm, [skip ahead to the fission install](#install-fi
|
||||
Ensure you have the Kubernetes CLI.
|
||||
|
||||
You can get the Kubernetes CLI for OSX like this:
|
||||
```
|
||||
```sh
|
||||
$ 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:
|
||||
```
|
||||
```sh
|
||||
$ 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:
|
||||
|
||||
```
|
||||
```sh
|
||||
$ kubectl version
|
||||
```
|
||||
|
||||
@@ -47,7 +47,7 @@ the next section](#install-fission).
|
||||
First, you'll need the helm CLI:
|
||||
|
||||
On __OS X__:
|
||||
```
|
||||
```sh
|
||||
$ curl -LO https://storage.googleapis.com/kubernetes-helm/helm-v2.7.0-darwin-amd64.tar.gz
|
||||
|
||||
$ tar xzf helm-v2.7.0-darwin-amd64.tar.gz
|
||||
@@ -56,7 +56,7 @@ $ mv darwin-amd64/helm /usr/local/bin
|
||||
```
|
||||
|
||||
On __Linux__:
|
||||
```
|
||||
```sh
|
||||
$ curl -LO https://storage.googleapis.com/kubernetes-helm/helm-v2.7.0-linux-amd64.tar.gz
|
||||
|
||||
$ tar xzf helm-v2.7.0-linux-amd64.tar.gz
|
||||
@@ -66,7 +66,7 @@ $ mv linux-amd64/helm /usr/local/bin
|
||||
|
||||
Next, install the Helm server on your Kubernetes cluster:
|
||||
|
||||
```
|
||||
```sh
|
||||
$ helm init
|
||||
```
|
||||
|
||||
@@ -74,8 +74,8 @@ $ helm init
|
||||
|
||||
#### Minikube
|
||||
|
||||
```
|
||||
$ helm install --namespace fission --set serviceType=NodePort https://github.com/fission/fission/releases/download/0.4.1/fission-all-0.4.1.tgz
|
||||
```sh
|
||||
$ helm install --namespace fission --set serviceType=NodePort https://github.com/fission/fission/releases/download/0.6.0/fission-all-0.6.0.tgz
|
||||
```
|
||||
|
||||
The serviceType variable allows configuring the type of Kubernetes
|
||||
@@ -84,8 +84,8 @@ want to expose anything outside the cluster.
|
||||
|
||||
#### Cloud hosted clusters (GKE, AWS, Azure etc.)
|
||||
|
||||
```
|
||||
$ helm install --namespace fission https://github.com/fission/fission/releases/download/0.4.1/fission-all-0.4.1.tgz
|
||||
```sh
|
||||
$ helm install --namespace fission https://github.com/fission/fission/releases/download/0.6.0/fission-all-0.6.0.tgz
|
||||
```
|
||||
|
||||
#### Minimal version
|
||||
@@ -94,8 +94,8 @@ 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:
|
||||
|
||||
```
|
||||
$ helm install --namespace fission https://github.com/fission/fission/releases/download/0.4.1/fission-core-0.4.1.tgz
|
||||
```sh
|
||||
$ helm install --namespace fission https://github.com/fission/fission/releases/download/0.6.0/fission-core-0.6.0.tgz
|
||||
```
|
||||
|
||||
### Install the Fission CLI
|
||||
@@ -104,68 +104,46 @@ $ helm install --namespace fission https://github.com/fission/fission/releases/d
|
||||
|
||||
Get the CLI binary for Mac:
|
||||
|
||||
```
|
||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/0.4.1/fission-cli-osx && chmod +x fission && sudo mv fission /usr/local/bin/
|
||||
```sh
|
||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/0.6.0/fission-cli-osx && chmod +x fission && sudo mv fission /usr/local/bin/
|
||||
```
|
||||
|
||||
#### Linux
|
||||
|
||||
```
|
||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/0.4.1/fission-cli-linux && chmod +x fission && sudo mv fission /usr/local/bin/
|
||||
```sh
|
||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/0.6.0/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/0.4.1/fission-cli-windows.exe)
|
||||
|
||||
### Set environment vars
|
||||
|
||||
Set the FISSION_URL and FISSION_ROUTER environment variables.
|
||||
FISSION_URL is used by the fission CLI to find the server.
|
||||
(FISSION_ROUTER is only needed for the examples below to work.)
|
||||
|
||||
#### Minikube
|
||||
|
||||
If you're using minikube, use these commands:
|
||||
|
||||
```
|
||||
$ export FISSION_URL=http://$(minikube ip):31313
|
||||
$ export FISSION_ROUTER=$(minikube ip):31314
|
||||
```
|
||||
#### Cloud setups
|
||||
|
||||
Save the external IP addresses of controller and router services in
|
||||
FISSION_URL and FISSION_ROUTER, respectively. Wait for services to
|
||||
get IP addresses (check this with ```kubectl --namespace fission get
|
||||
svc```). Then:
|
||||
|
||||
##### AWS
|
||||
```
|
||||
$ export FISSION_URL=http://$(kubectl --namespace fission get svc controller -o=jsonpath='{..hostname}')
|
||||
$ export FISSION_ROUTER=$(kubectl --namespace fission get svc router -o=jsonpath='{..hostname}')
|
||||
```
|
||||
|
||||
##### GCP
|
||||
```
|
||||
$ export FISSION_URL=http://$(kubectl --namespace fission get svc controller -o=jsonpath='{..ip}')
|
||||
$ export FISSION_ROUTER=$(kubectl --namespace fission get svc router -o=jsonpath='{..ip}')
|
||||
```
|
||||
this windows executable: [fission.exe](https://github.com/fission/fission/releases/download/0.6.0/fission-cli-windows.exe)
|
||||
|
||||
### Run an example
|
||||
|
||||
Finally, you're ready to use Fission!
|
||||
|
||||
```
|
||||
$ fission env create --name nodejs --image fission/node-env:0.4.1
|
||||
```sh
|
||||
$ fission env create --name nodejs --image fission/node-env:0.6.0
|
||||
|
||||
$ 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
|
||||
$ fission function test --name hello
|
||||
Hello, world!
|
||||
```
|
||||
|
||||
$ curl http://$FISSION_ROUTER/hello
|
||||
For a compiled language like Go:
|
||||
|
||||
```sh
|
||||
$ fission env create --name go --image fission/go-env:0.6.0 --builder fission/go-builder:0.6.0
|
||||
|
||||
$ curl -LO https://raw.githubusercontent.com/fission/fission/master/examples/go/hello.go
|
||||
|
||||
$ fission function create --name gohello --env go --src hello.go --entrypoint Handler
|
||||
|
||||
$ fission function test --name gohello
|
||||
Hello, world!
|
||||
```
|
||||
|
||||
@@ -177,4 +155,3 @@ slack channel](http://slack.fission.io) and ask for help.
|
||||
Check out the
|
||||
[examples](https://github.com/fission/fission/tree/master/examples)
|
||||
for some example functions.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Kubernetes Quick Install"
|
||||
date: 2017-09-07T20:10:05-07:00
|
||||
draft: false
|
||||
weight: 21
|
||||
---
|
||||
|
||||
This is a quick guide to help you get started running Kubernetes on
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: "Release notes"
|
||||
draft: false
|
||||
weight: 22
|
||||
---
|
||||
|
||||
- The fission team is on http://slack.fission.io if you have any questions.
|
||||
|
||||
### 0.4.0
|
||||
|
||||
- This release is compatible with Kubernetes 1.7 onwards.
|
||||
- We switched from ThirdPartyResources to CustomResourceDefinitions. ThirdPartyResources are removed in Kubernetes 1.8, so upgrade with caution, using the upgrade guide below.
|
||||
- Upgrade guides:
|
||||
- [Upgrade guide from 0.3.0](../upgrade/upgrade-from-v0.3)
|
||||
- To upgrade from 0.2.1, please upgrade to 0.3.0 first, following the upgrade guide in the 0.3.0 release.
|
||||
|
||||
### 0.3.0
|
||||
|
||||
Note: This release is incompatible with Kubernetes 1.8 (Because it uses ThirdPartyResources; see #314)
|
||||
|
||||
This release introduces:
|
||||
|
||||
- Build pipeline. Currently, only the Python environment supports this.
|
||||
- Workflow engine support (compatible with fission-workflows 0.1.1)
|
||||
|
||||
### v0.2.1
|
||||
|
||||
Lots of big changes in this release!
|
||||
|
||||
- Most importantly, the API has changed a lot. We switched to Kubernetes
|
||||
ThirdPartyResources, and improved various pieces of the API to support
|
||||
new environments.
|
||||
|
||||
- The old API was too different from widely used Kubernetes patterns,
|
||||
and so we decided to fully break compatibility for this release. We're still in
|
||||
alpha, so you should expect the occasional API breakage; we'll be
|
||||
better at preserving compatibility once we reach beta.
|
||||
|
||||
- The CLI is still compatible. Environments are also still compatible --
|
||||
environment images that worked before continue to work.
|
||||
|
||||
- We're creating an upgrade tool to help migrate; if you're upgrading
|
||||
v0.1.0 and can't do a fresh install, wait for the upgrade tool.
|
||||
|
||||
- We now use Helm for installation instead of a set of YAML files.
|
||||
|
||||
- The Fission "controller" is now stateless. Fission's etcd deployment
|
||||
is removed, since Fission stores state in ThirdPartyResources. Large
|
||||
function files are stored in a new function storage service, which
|
||||
uses a persistent volume.
|
||||
|
||||
- And, we've started a new docs site; for now it's just the installation
|
||||
and upgrade guides, but we'll be writing more docs soon.
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: "Upgrade"
|
||||
weight: 30
|
||||
---
|
||||
|
||||
### From v0.4.x to v0.5.0
|
||||
* [Upgrade guide](upgrade-from-v0.4)
|
||||
|
||||
### From v0.3 to v0.4.x
|
||||
* [Upgrade guide](upgrade-from-v0.3)
|
||||
|
||||
### From v0.1 to v0.2.x
|
||||
* [Upgrade guide](upgrade-from-v0.1)
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Upgrading from Fission v0.1 to v0.2.x"
|
||||
date: 2017-09-08T16:26:29-07:00
|
||||
title: "Upgrading from v0.1 to v0.2.x"
|
||||
draft: false
|
||||
weight: 31
|
||||
---
|
||||
|
||||
## TL;DR
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Upgrading from Fission v0.3 to v0.4.x"
|
||||
date: 2017-11-04T03:38:29+08:00
|
||||
title: "Upgrading from v0.3 to v0.4.x"
|
||||
draft: false
|
||||
weight: 32
|
||||
---
|
||||
|
||||
## Introduction
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
title: "Upgrading from v0.4.x to v0.5.0"
|
||||
draft: false
|
||||
weight: 33
|
||||
---
|
||||
|
||||
## How to Upgrade
|
||||
|
||||
1. Get the 0.5.0 CLI
|
||||
2. Upgrade to Fission 0.5.0
|
||||
|
||||
### Get the new CLI
|
||||
|
||||
#### OS X
|
||||
|
||||
``` bash
|
||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/0.5.0/fission-cli-osx && chmod +x fission && sudo mv fission /usr/local/bin/
|
||||
```
|
||||
|
||||
#### Linux
|
||||
|
||||
``` bash
|
||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/0.5.0/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/0.5.0/fission-cli-windows.exe)
|
||||
|
||||
### Upgrade to Fission 0.5.0
|
||||
|
||||
Upgrade fission with a command similar to this:
|
||||
|
||||
|
||||
|
||||
``` bash
|
||||
# find the release want to upgrade
|
||||
$ helm list
|
||||
|
||||
# upgrade to 0.5.0
|
||||
$ helm upgrade <release_name> https://github.com/fission/fission/releases/download/0.5.0/fission-all-0.5.0.tgz
|
||||
```
|
||||
@@ -0,0 +1,203 @@
|
||||
---
|
||||
title: "Enabling Istio on Fission"
|
||||
draft: false
|
||||
weight: 42
|
||||
---
|
||||
|
||||
This is the very first step for fission to integrate with [Istio](https://istio.io/). For those interested in trying to integrate fission with istio, following is the set up tutorial.
|
||||
|
||||
## Test Environment
|
||||
* Google Kubernetes Engine: 1.9.2-gke.1
|
||||
|
||||
## Set Up
|
||||
### Create Kubernetes v1.9+ cluster
|
||||
|
||||
Enable both RBAC & initializer features on kubernetes cluster.
|
||||
|
||||
``` bash
|
||||
$ export ZONE=<zone name>
|
||||
$ gcloud container clusters create istio-demo-1 \
|
||||
--machine-type=n1-standard-2 \
|
||||
--num-nodes=1 \
|
||||
--no-enable-legacy-authorization \
|
||||
--zone=$ZONE \
|
||||
--cluster-version=1.9.2-gke.1
|
||||
```
|
||||
|
||||
### Grant cluster admin permissions
|
||||
|
||||
Grant admin permission for `system:serviceaccount:kube-system:default` and current user.
|
||||
|
||||
``` bash
|
||||
# for system:serviceaccount:kube-system:default
|
||||
$ kubectl create clusterrolebinding --user system:serviceaccount:kube-system:default kube-system-cluster-admin --clusterrole cluster-admin
|
||||
|
||||
# for current user
|
||||
$ kubectl create clusterrolebinding cluster-admin-binding --clusterrole=cluster-admin --user=$(gcloud config get-value core/account)
|
||||
```
|
||||
|
||||
### Set up Istio environment
|
||||
|
||||
For Istio 0.5.1 you can follow the installation tutorial below. Also, you can follow the latest installation guides on Istio official site: [Quick Start](https://istio.io/docs/setup/kubernetes/quick-start.html) and [Sidecar Injection](https://istio.io/docs/setup/kubernetes/sidecar-injection.html).
|
||||
|
||||
|
||||
Download Istio 0.5.1
|
||||
|
||||
``` bash
|
||||
$ export ISTIO_VERSION=0.5.1
|
||||
$ curl -L https://git.io/getLatestIstio | sh -
|
||||
$ cd istio-0.5.1
|
||||
```
|
||||
|
||||
Apply istio related YAML files
|
||||
|
||||
``` bash
|
||||
$ kubectl apply -f install/kubernetes/istio.yaml
|
||||
```
|
||||
|
||||
Automatic sidecar injection
|
||||
|
||||
``` bash
|
||||
$ kubectl api-versions | grep admissionregistration
|
||||
admissionregistration.k8s.io/v1beta1
|
||||
```
|
||||
|
||||
Installing the webhook
|
||||
|
||||
Download the missing files in istio release 0.5.1
|
||||
|
||||
``` bash
|
||||
$ wget https://raw.githubusercontent.com/istio/istio/master/install/kubernetes/webhook-create-signed-cert.sh -P install/kubernetes/
|
||||
$ wget https://raw.githubusercontent.com/istio/istio/master/install/kubernetes/webhook-patch-ca-bundle.sh -P install/kubernetes/
|
||||
$ chmod +x install/kubernetes/webhook-create-signed-cert.sh install/kubernetes/webhook-patch-ca-bundle.sh
|
||||
```
|
||||
|
||||
Install the sidecar injection configmap.
|
||||
|
||||
``` bash
|
||||
$ ./install/kubernetes/webhook-create-signed-cert.sh \
|
||||
--service istio-sidecar-injector \
|
||||
--namespace istio-system \
|
||||
--secret sidecar-injector-certs
|
||||
|
||||
$ kubectl apply -f install/kubernetes/istio-sidecar-injector-configmap-release.yaml
|
||||
```
|
||||
|
||||
Install the sidecar injector
|
||||
|
||||
``` bash
|
||||
$ cat install/kubernetes/istio-sidecar-injector.yaml | \
|
||||
./install/kubernetes/webhook-patch-ca-bundle.sh > \
|
||||
install/kubernetes/istio-sidecar-injector-with-ca-bundle.yaml
|
||||
|
||||
$ kubectl apply -f install/kubernetes/istio-sidecar-injector-with-ca-bundle.yaml
|
||||
|
||||
# Check sidecar injector status
|
||||
$ kubectl -n istio-system get deployment -listio=sidecar-injector
|
||||
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
|
||||
istio-sidecar-injector 1 1 1 1 26s
|
||||
```
|
||||
|
||||
### Install fission
|
||||
|
||||
Set default namespace for helm installation, here we use `fission` as example namespace.
|
||||
``` bash
|
||||
$ export FISSION_NAMESPACE=fission
|
||||
```
|
||||
|
||||
Create namespace & add label for Istio sidecar injection.
|
||||
|
||||
``` bash
|
||||
$ kubectl create namespace $FISSION_NAMESPACE
|
||||
$ kubectl label namespace $FISSION_NAMESPACE istio-injection=enabled
|
||||
$ kubectl config set-context $(kubectl config current-context) --namespace=$FISSION_NAMESPACE
|
||||
```
|
||||
|
||||
Follow the [installation guide](../../installation/) to install fission with flag `enableIstio` true.
|
||||
|
||||
``` bash
|
||||
$ helm install --namespace $FISSION_NAMESPACE --set enableIstio=true --name istio-demo <chart-fission-all-url>
|
||||
```
|
||||
|
||||
### Create a function
|
||||
|
||||
Set environment
|
||||
|
||||
``` bash
|
||||
$ export FISSION_URL=http://$(kubectl --namespace fission get svc controller -o=jsonpath='{..ip}')
|
||||
$ export FISSION_ROUTER=$(kubectl --namespace fission get svc router -o=jsonpath='{..ip}')
|
||||
```
|
||||
|
||||
Let's create a simple function with Node.js.
|
||||
|
||||
``` js
|
||||
# hello.js
|
||||
module.exports = async function(context) {
|
||||
console.log(context.request.headers);
|
||||
return {
|
||||
status: 200,
|
||||
body: "Hello, World!\n"
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
Create environment
|
||||
|
||||
``` bash
|
||||
$ fission env create --name nodejs --image fission/node-env:latest
|
||||
```
|
||||
|
||||
Create function
|
||||
|
||||
``` bash
|
||||
$ fission fn create --name h1 --env nodejs --code hello.js --method GET
|
||||
```
|
||||
|
||||
Create route
|
||||
|
||||
``` bash
|
||||
$ fission route create --method GET --url /h1 --function h1
|
||||
```
|
||||
|
||||
Access function
|
||||
|
||||
``` bash
|
||||
$ curl http://$FISSION_ROUTER/h1
|
||||
Hello, World!
|
||||
```
|
||||
|
||||
|
||||
### Install Istio Add-ons
|
||||
|
||||
* Prometheus
|
||||
|
||||
``` bash
|
||||
$ kubectl apply -f istio-0.5.1/install/kubernetes/addons/prometheus.yaml
|
||||
$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=prometheus -o jsonpath='{.items[0].metadata.name}') 9090:9090
|
||||
```
|
||||
|
||||
Web Link: [http://127.0.0.1:9090/graph](http://127.0.0.1:9090/graph)
|
||||
|
||||
* Grafana
|
||||
|
||||
Please install Prometheus first.
|
||||
|
||||

|
||||
|
||||
``` bash
|
||||
$ kubectl apply -f istio-0.5.1/install/kubernetes/addons/grafana.yaml
|
||||
$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=grafana -o jsonpath='{.items[0].metadata.name}') 3000:3000
|
||||
```
|
||||
|
||||
Web Link: [http://127.0.0.1:3000/dashboard/db/istio-dashboard](http://127.0.0.1:3000/dashboard/db/istio-dashboard)
|
||||
|
||||
* Jaegar
|
||||
|
||||

|
||||
|
||||
``` bash
|
||||
$ kubectl apply -n istio-system -f https://raw.githubusercontent.com/jaegertracing/jaeger-kubernetes/master/all-in-one/jaeger-all-in-one-template.yml
|
||||
$ kubectl port-forward -n istio-system $(kubectl get pod -n istio-system -l app=jaeger -o jsonpath='{.items[0].metadata.name}') 16686:16686
|
||||
```
|
||||
|
||||
Web Link: [http://localhost:16686](http://localhost:16686)
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "Using Fission"
|
||||
chapter: true
|
||||
draft: false
|
||||
weight: 40
|
||||
---
|
||||
|
||||
# Using Fission
|
||||
|
||||
### Usage guides, tutorials and examples
|
||||
@@ -0,0 +1,120 @@
|
||||
---
|
||||
title: "Accessing Secrets in Functions"
|
||||
draft: false
|
||||
weight: 47
|
||||
---
|
||||
|
||||
Functions can access Kubernetes
|
||||
[Secrets](https://kubernetes.io/docs/concepts/configuration/secret/)
|
||||
and
|
||||
[ConfigMaps](https://kubernetes.io/docs/concepts/storage/volumes/#configmap).
|
||||
|
||||
Use secrets for things like API keys, authentication tokens, and so
|
||||
on.
|
||||
|
||||
Use config maps for any other configuration that doesn't need to be a
|
||||
secret.
|
||||
|
||||
### Create A Secret or a ConfigMap
|
||||
|
||||
You can create a Secret or ConfigMap with the Kubernetes CLI:
|
||||
|
||||
``` bash
|
||||
$ kubectl -n default create secret generic my-secret --from-literal=TEST_KEY="TESTVALUE"
|
||||
|
||||
$ kubectl -n default create configmap my-configmap --from-literal=TEST_KEY="TESTVALUE"
|
||||
```
|
||||
|
||||
Or, use `kubectl create -f <filename.yaml>` to create these from a YAML file.
|
||||
|
||||
``` yaml
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
namespace: default
|
||||
name: my-secret
|
||||
data:
|
||||
TEST_KEY: VEVTVFZBTFVF # value after base64 encode
|
||||
type: Opaque
|
||||
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
metadata:
|
||||
namespace: default
|
||||
name: my-configmap
|
||||
data:
|
||||
TEST_KEY: TESTVALUE
|
||||
```
|
||||
|
||||
### Accessing Secrets and ConfigMaps
|
||||
|
||||
Secrets and configmaps are accessed similarly. Each secret or
|
||||
configmap is a set of key value pairs. Fission sets these up as files
|
||||
you can read from your function.
|
||||
|
||||
``` bash
|
||||
# Secret path
|
||||
/secrets/<namespace>/<name>/<key>
|
||||
|
||||
# ConfigMap path
|
||||
/configs/<namespace>/<name>/<key>
|
||||
```
|
||||
|
||||
From the previous example, the paths are:
|
||||
|
||||
``` bash
|
||||
# secret my-secret
|
||||
/secrets/default/my-secret/TEST_KEY
|
||||
|
||||
# confimap my-configmap
|
||||
/configs/default/my-configmap/TEST_KEY
|
||||
```
|
||||
|
||||
Now, let's create a simple python function (leaker.py) that returns
|
||||
the value of Secret `my-secret` and ConfigMap `my-configmap`.
|
||||
|
||||
``` python
|
||||
# leaker.py
|
||||
|
||||
def main():
|
||||
path = "/configs/default/my-configmap/TEST_KEY"
|
||||
f = open(path, "r")
|
||||
config = f.read()
|
||||
|
||||
path = "/secrets/default/my-secret/TEST_KEY"
|
||||
f = open(path, "r")
|
||||
secret = f.read()
|
||||
|
||||
msg = "ConfigMap: %s\nSecret: %s" % (config, secret)
|
||||
|
||||
return msg, 200
|
||||
```
|
||||
|
||||
|
||||
Create an environment and a function:
|
||||
|
||||
``` bash
|
||||
# create python env
|
||||
$ fission env create --name python --image fission/python-env
|
||||
|
||||
# create function named "leaker"
|
||||
$ fission fn create --name leaker --env python --code leaker.py --secret my-secret --configmap my-configmap
|
||||
```
|
||||
|
||||
|
||||
Run the function, and the output should look like this:
|
||||
|
||||
``` bash
|
||||
$ fission function test --name leaker
|
||||
ConfigMap: TESTVALUE
|
||||
Secret: TESTVALUE
|
||||
```
|
||||
|
||||
|
||||
{{% notice note %}}
|
||||
If the Secret or ConfigMap value is updated, the function may
|
||||
not get the updated value for some time; it may get a cached older
|
||||
value.
|
||||
{{% /notice %}}
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
title: "Environment"
|
||||
draft: false
|
||||
weight: 42
|
||||
---
|
||||
|
||||
### Create an environment
|
||||
|
||||
You can create an environment on your cluster from an image for that language. Optionally, you can specify CPU and memory resource limits. You can also specify the number of initially pre-warmed pods, which is called the poolsize.
|
||||
|
||||
```
|
||||
$ fission env create --name node --image fission/node-env:0.4.0 --mincpu 40 --maxcpu 80 --minmemory 64 --maxmemory 128 --poolsize 4
|
||||
```
|
||||
|
||||
In case of pool based executor, the resources specified for environment are used for function pod as well. In case of new deployment executor, you can override the resources when you create a function.
|
||||
|
||||
### Using a builder
|
||||
|
||||
When you create an environment, you can specify a builder image and builder command which will be used for building from source code. You can override the build command when creating a function. For more details on builder and packages you should check out examples in [Functions](../functions) and [packages](../package)
|
||||
|
||||
```
|
||||
$ fission env create --name python --image fission/python-env:latest --builder fission/python-builder:latest
|
||||
```
|
||||
|
||||
### Viewing environment information
|
||||
|
||||
You can list the environments or view information of an individual environment:
|
||||
|
||||
```
|
||||
$ fission env list
|
||||
NAME UID IMAGE POOLSIZE MINCPU MAXCPU MINMEMORY MAXMEMORY
|
||||
node ac84d62e-001f-11e8-85c9-42010aa00010 fission/node-env:0.4.0 4 40m 80m 64Mi 128Mi
|
||||
|
||||
$ fission env get --name node
|
||||
NAME UID IMAGE
|
||||
node ac84d62e-001f-11e8-85c9-42010aa00010 fission/node-env:0.4.0
|
||||
```
|
||||
@@ -0,0 +1,86 @@
|
||||
---
|
||||
title: "Controlling Function Execution"
|
||||
draft: false
|
||||
weight: 43
|
||||
---
|
||||
|
||||
### Autoscaling
|
||||
|
||||
Let's create a function to demonstrate the autoscaling behaviour in Fission. We create a simple function which outputs "Hello World" in using NodeJS. We have kept the CPU request and limit purposefully low to simulate the load and also kept the target CPU percent to 50%.
|
||||
|
||||
```
|
||||
$ fission fn create --name hello --env node --code hello.js --mincpu 10 --maxcpu 40 --minmemory 64 --maxmemory 128 --minscale 1 --maxscale 6 --executortype newdeploy --targetcpu 50
|
||||
function 'hello' created
|
||||
```
|
||||
|
||||
Now let's use [hey](https://github.com/rakyll/hey) to generate the load with 250 concurrent and a total of 10000 requests:
|
||||
|
||||
```
|
||||
$ hey -c 250 -n 10000 http://$FISSION_ROUTER/hello
|
||||
Summary:
|
||||
Total: 67.3535 secs
|
||||
Slowest: 4.6192 secs
|
||||
Fastest: 0.0177 secs
|
||||
Average: 1.6464 secs
|
||||
Requests/sec: 148.4704
|
||||
Total data: 160000 bytes
|
||||
Size/request: 16 bytes
|
||||
|
||||
Response time histogram:
|
||||
0.018 [1] |
|
||||
0.478 [486] |∎∎∎∎∎∎∎
|
||||
0.938 [971] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎
|
||||
1.398 [2686] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎
|
||||
1.858 [2326] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎
|
||||
2.318 [1641] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎
|
||||
2.779 [1157] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎
|
||||
3.239 [574] |∎∎∎∎∎∎∎∎∎
|
||||
3.699 [120] |∎∎
|
||||
4.159 [0] |
|
||||
4.619 [38] |∎
|
||||
|
||||
Latency distribution:
|
||||
10% in 0.7037 secs
|
||||
25% in 1.1979 secs
|
||||
50% in 1.5038 secs
|
||||
75% in 2.1959 secs
|
||||
90% in 2.6670 secs
|
||||
95% in 2.8855 secs
|
||||
99% in 3.4102 secs
|
||||
|
||||
Details (average, fastest, slowest):
|
||||
DNS+dialup: 0.0058 secs, 0.0000 secs, 1.0853 secs
|
||||
DNS-lookup: 0.0000 secs, 0.0000 secs, 0.0000 secs
|
||||
req write: 0.0000 secs, 0.0000 secs, 0.0026 secs
|
||||
resp wait: 1.6405 secs, 0.0176 secs, 3.6144 secs
|
||||
resp read: 0.0001 secs, 0.0000 secs, 0.0056 secs
|
||||
|
||||
Status code distribution:
|
||||
[200] 10000 responses
|
||||
|
||||
```
|
||||
While the load is being generated, we will watch the HorizontalPodAutoscaler and how it scales over period of time. As you can notice, the number of pods is scaled from 1 to 3 after the load rises from 8 - 103%. After the load generator stops, it takes a few iterations to scale down from 3 to 1 pod.
|
||||
|
||||
```
|
||||
$ kubectl -n fission-function get hpa -w
|
||||
NAME REFERENCE TARGETS MINPODS MAXPODS REPLICAS AGE
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 1 3m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 8% / 50% 1 6 1 3m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 103% / 50% 1 6 1 4m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 103% / 50% 1 6 3 5m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 25% / 50% 1 6 3 5m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 25% / 50% 1 6 3 6m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 6m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 7m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 7m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 8m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 8m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 9m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 9m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 10m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 10m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 7% / 50% 1 6 1 11m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 6% / 50% 1 6 1 11m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 6% / 50% 1 6 1 12m
|
||||
hello-qoxmothj Deployment/hello-qoxmothj 6% / 50% 1 6 1 12m
|
||||
```
|
||||
@@ -0,0 +1,271 @@
|
||||
---
|
||||
title: "Function"
|
||||
draft: false
|
||||
weight: 41
|
||||
---
|
||||
|
||||
### Create a function
|
||||
|
||||
Before creating a function the environment should be created, we will assume that you have already created environment named `node`.
|
||||
|
||||
Let's create a simple code snippet in nodejs which will output Hello world:
|
||||
|
||||
``` js
|
||||
module.exports = async function(context) {
|
||||
return {
|
||||
status: 200,
|
||||
body: "Hello, world!\n"
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
Let's create a function based on pool based executor.
|
||||
|
||||
``` bash
|
||||
$ fission fn create --name hello --code hello.js --env node --executortype poolmgr
|
||||
```
|
||||
|
||||
### Access function
|
||||
|
||||
Before accessing function, we need to set the `FISSION_ROUTER` environment variable first. It is needed for the examples below to work
|
||||
|
||||
#### Minikube
|
||||
|
||||
If you're using minikube, use these commands:
|
||||
|
||||
``` bash
|
||||
$ export FISSION_ROUTER=$(minikube ip):$(kubectl -n fission get svc router -o jsonpath='{...nodePort}')
|
||||
```
|
||||
|
||||
#### Cloud setups
|
||||
|
||||
Save the external IP addresses of router services in FISSION_ROUTER.
|
||||
|
||||
Wait for services to get IP addresses (check this with `kubectl --namespace fission get svc`). Then:
|
||||
|
||||
``` bash
|
||||
# AWS
|
||||
$ export FISSION_ROUTER=$(kubectl --namespace fission get svc router -o=jsonpath='{..hostname}')
|
||||
|
||||
# GCP
|
||||
$ export FISSION_ROUTER=$(kubectl --namespace fission get svc router -o=jsonpath='{..ip}')
|
||||
```
|
||||
|
||||
#### Create a HTTP trigger
|
||||
|
||||
Let's create a route for the function which can be used for making HTTP requests:
|
||||
|
||||
``` bash
|
||||
$ fission route create --function hello --url /hello
|
||||
trigger '5327e9a7-6d87-4533-a4fb-c67f55b1e492' created
|
||||
```
|
||||
|
||||
When you hit this function's URL , you get a response:
|
||||
|
||||
``` bash
|
||||
$ curl http://$FISSION_ROUTER/hello
|
||||
Hello, world!
|
||||
```
|
||||
|
||||
Similarly you can create a new deployment executor type function and provide minmum and maximum scale for the function.
|
||||
|
||||
``` bash
|
||||
$ fission fn create --name hello --code hello.js --env node --minscale 1 --maxscale 5 --executortype newdeploy
|
||||
```
|
||||
|
||||
### View & update function source code
|
||||
|
||||
You can look at the source code associated with given function:
|
||||
|
||||
``` bash
|
||||
$ fission fn get --name hello
|
||||
module.exports = async function(context) {
|
||||
return {
|
||||
status: 200,
|
||||
body: "Hello, world!\n"
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
Let's say you want to update the function to output "Hello Fission" instead of "Hello world", you can update the source file and update the source code for function:
|
||||
|
||||
``` bash
|
||||
$ fission fn update --name hello --code ../hello.js
|
||||
package 'hello-js-ku9s' updated
|
||||
function 'hello' updated
|
||||
```
|
||||
|
||||
Let's verify that the function now respond with a different output than earlier:
|
||||
|
||||
``` bash
|
||||
$ curl http://$FISSION_ROUTER/hello
|
||||
Hello, Fission!
|
||||
```
|
||||
|
||||
### Test and debug function
|
||||
|
||||
You can directly test a function using test command. If the function call succeeds, it will output the function's response.
|
||||
``` bash
|
||||
$ fission fn test --name hello
|
||||
Hello, Fission!
|
||||
```
|
||||
|
||||
But if there is an error in function execution then the logs of function execution are displayed:
|
||||
``` bash
|
||||
$ fission fn test --name hello
|
||||
Error calling function hello: 500 Internal server error (fission)
|
||||
|
||||
> fission-nodejs-runtime@0.1.0 start /usr/src/app
|
||||
> node server.js
|
||||
|
||||
Codepath defaulting to /userfunc/user
|
||||
Port defaulting to 8888
|
||||
user code load error: SyntaxError: Unexpected token function
|
||||
::ffff:10.8.1.181 - - [16/Feb/2018:08:44:33 +0000] "POST /specialize HTTP/1.1" 500 2 "-" "Go-http-client/1.1"
|
||||
|
||||
```
|
||||
|
||||
You can also look at function execution logs explicitly:
|
||||
``` bash
|
||||
$ fission fn logs --name hello
|
||||
[2018-02-16 08:41:43 +0000 UTC] 2018/02/16 08:41:43 fetcher received fetch request and started downloading: {1 {hello-js-rqew default 0 0001-01-01 00:00:00 +0000 UTC <nil> <nil> map[] map[] [] nil [] } user [] []}
|
||||
[2018-02-16 08:41:43 +0000 UTC] 2018/02/16 08:41:43 Successfully placed at /userfunc/user
|
||||
[2018-02-16 08:41:43 +0000 UTC] 2018/02/16 08:41:43 Checking secrets/cfgmaps
|
||||
[2018-02-16 08:41:43 +0000 UTC] 2018/02/16 08:41:43 Completed fetch request
|
||||
[2018-02-16 08:41:43 +0000 UTC] 2018/02/16 08:41:43 elapsed time in fetch request = 89.844653ms
|
||||
[2018-02-16 08:41:43 +0000 UTC] user code loaded in 0sec 4.235593ms
|
||||
[2018-02-16 08:41:43 +0000 UTC] ::ffff:10.8.1.181 - - [16/Feb/2018:08:41:43 +0000] "POST /specialize HTTP/1.1" 202 - "-" "Go-http-client/1.1"
|
||||
[2018-02-16 08:41:43 +0000 UTC] ::ffff:10.8.1.182 - - [16/Feb/2018:08:41:43 +0000] "GET / HTTP/1.1" 200 16 "-" "curl/7.54.0"
|
||||
```
|
||||
|
||||
### Fission builds & compiled artifacts
|
||||
|
||||
Most real world functions will require more than one source files. It is also easier to simply provide source files and let Fission take care of building from source files. Fission provides first class support for building from source as well as using compiled artifacts to create functions.
|
||||
|
||||
You can attach the source/deployment packages to a function or explicitly create packages and use them across functions. Check documentation for [package](../package) for more information.
|
||||
|
||||
#### Building function from source
|
||||
|
||||
Let's take a simple python function which has dependency on a python pyyaml module. We can specify the dependencies in requirements.txt and a simple command to build from source. The tree structure of directory looks like:
|
||||
|
||||
``` bash
|
||||
sourcepkg/
|
||||
├── __init__.py
|
||||
├── build.sh
|
||||
├── requirements.txt
|
||||
└── user.py
|
||||
```
|
||||
|
||||
And the file contents:
|
||||
|
||||
``` bash
|
||||
$ cat user.py
|
||||
import sys
|
||||
import yaml
|
||||
|
||||
document = """
|
||||
a: 1
|
||||
b:
|
||||
c: 3
|
||||
d: 4
|
||||
"""
|
||||
|
||||
def main():
|
||||
return yaml.dump(yaml.load(document))
|
||||
|
||||
$ cat requirements.txt
|
||||
pyyaml
|
||||
|
||||
$ cat build.sh
|
||||
#!/bin/sh
|
||||
pip3 install -r ${SRC_PKG}/requirements.txt -t ${SRC_PKG} && cp -r ${SRC_PKG} ${DEPLOY_PKG}
|
||||
```
|
||||
|
||||
You first need to create an environment with environment image and python-builder image specified:
|
||||
|
||||
``` bash
|
||||
$ fission env create --name python --image fission/python-env:latest --builder fission/python-builder:latest --mincpu 40 --maxcpu 80 --minmemory 64 --maxmemory 128 --poolsize 2
|
||||
```
|
||||
|
||||
Now let's zip the directory containing the source files and create a function with source package:
|
||||
|
||||
``` bash
|
||||
$ zip -jr demo-src-pkg.zip sourcepkg/
|
||||
adding: __init__.py (stored 0%)
|
||||
adding: build.sh (deflated 24%)
|
||||
adding: requirements.txt (stored 0%)
|
||||
adding: user.py (deflated 25%)
|
||||
|
||||
$ fission fn create --name hellopy --env python --src demo-src-pkg.zip --entrypoint "user.main" --buildcmd "./build.sh"
|
||||
function 'hellopy' created
|
||||
|
||||
$ fission route create --function hellopy --url /hellopy
|
||||
```
|
||||
|
||||
Once we create the function, the build process is started. You can check logs of the builder in fission-builder namespace:
|
||||
|
||||
``` bash
|
||||
$ kubectl -n fission-builder logs -f py3-4214348-59555d9bd8-ks7m4 builder
|
||||
2018/02/16 11:44:21 Builder received request: {demo-src-pkg-zip-ninf-djtswo ./build.sh}
|
||||
2018/02/16 11:44:21 Starting build...
|
||||
|
||||
=== Build Logs ===command=./build.sh
|
||||
env=[PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin HOSTNAME=py3-4214348-59555d9bd8-ks7m4 PYTHON_4212095_PORT_8000_TCP_PROTO=tcp PY3_4214348_SERVICE_HOST=10.11.250.161 KUBERNETES_PORT=tcp://10.11.240.1:443 PYTHON_4212095_PORT=tcp://10.11.244.134:8000 PYTHON_4212095_PORT_8000_TCP=tcp://10.11.244.134:8000 PYTHON_4212095_PORT_8001_TCP_PROTO=tcp PYTHON_4212095_PORT_8001_TCP_ADDR=10.11.244.134 PY3_4214348_SERVICE_PORT=8000 PY3_4214348_SERVICE_PORT_BUILDER_PORT=8001 PY3_4214348_PORT_8001_TCP=tcp://10.11.250.161:8001 KUBERNETES_PORT_443_TCP_PORT=443 KUBERNETES_PORT_443_TCP_ADDR=10.11.240.1 PY3_4214348_SERVICE_PORT_FETCHER_PORT=8000 PY3_4214348_PORT_8000_TCP=tcp://10.11.250.161:8000 PY3_4214348_PORT_8001_TCP_PORT=8001 PYTHON_4212095_SERVICE_PORT_FETCHER_PORT=8000 PYTHON_4212095_PORT_8000_TCP_ADDR=10.11.244.134 KUBERNETES_SERVICE_HOST=10.11.240.1 PY3_4214348_PORT=tcp://10.11.250.161:8000 PYTHON_4212095_SERVICE_PORT_BUILDER_PORT=8001 PYTHON_4212095_PORT_8001_TCP=tcp://10.11.244.134:8001 PY3_4214348_PORT_8000_TCP_PROTO=tcp PY3_4214348_PORT_8000_TCP_PORT=8000 KUBERNETES_SERVICE_PORT_HTTPS=443 KUBERNETES_PORT_443_TCP=tcp://10.11.240.1:443 PYTHON_4212095_PORT_8001_TCP_PORT=8001 PY3_4214348_PORT_8000_TCP_ADDR=10.11.250.161 PY3_4214348_PORT_8001_TCP_PROTO=tcp KUBERNETES_SERVICE_PORT=443 PYTHON_4212095_SERVICE_PORT=8000 PYTHON_4212095_PORT_8000_TCP_PORT=8000 PY3_4214348_PORT_8001_TCP_ADDR=10.11.250.161 KUBERNETES_PORT_443_TCP_PROTO=tcp PYTHON_4212095_SERVICE_HOST=10.11.244.134 HOME=/root SRC_PKG=/packages/demo-src-pkg-zip-ninf-djtswo DEPLOY_PKG=/packages/demo-src-pkg-zip-ninf-djtswo-c40gfu]
|
||||
Collecting pyyaml (from -r /packages/demo-src-pkg-zip-ninf-djtswo/requirements.txt (line 1))
|
||||
Downloading PyYAML-3.12.tar.gz (253kB)
|
||||
Installing collected packages: pyyaml
|
||||
Running setup.py install for pyyaml: started
|
||||
Running setup.py install for pyyaml: finished with status 'done'
|
||||
Successfully installed pyyaml-3.12
|
||||
==================
|
||||
2018/02/16 11:44:24 elapsed time in build request = 3.460498847s
|
||||
```
|
||||
|
||||
Once the build has succeeded, you can hit the function URL to test the function:
|
||||
``` bash
|
||||
$ curl http://$FISSION_ROUTER/hellopy
|
||||
a: 1
|
||||
b: {c: 3, d: 4}
|
||||
```
|
||||
|
||||
#### Using compiled artifacts with Fission
|
||||
|
||||
In some cases you have a pre-built deployment package which you need to deploy to Fission. For this example let's use a simple python file as a deployment package but in practice it can be any other compiled package.
|
||||
|
||||
We will use a simple python file in a directory and turn it into a deployment package:
|
||||
|
||||
``` bash
|
||||
$ cat testDir/hello.py
|
||||
def main():
|
||||
return "Hello, world!"
|
||||
|
||||
$zip -jr demo-deploy-pkg.zip testDir/
|
||||
|
||||
```
|
||||
|
||||
Let's use the deployment package to create a function and route and then test it.
|
||||
|
||||
``` bash
|
||||
$ fission fn create --name hellopy --env python --deploy demo-deploy-pkg.zip --entrypoint "hello.main"
|
||||
function 'hellopy' created
|
||||
|
||||
$ fission route create --function hellopy --url /hellopy
|
||||
|
||||
$ curl http://$FISSION_ROUTER/hellopy
|
||||
Hello, world!
|
||||
```
|
||||
|
||||
### View function information
|
||||
|
||||
You can retrieve metadata information of a single function or list all functions to look at basic information of functions:
|
||||
|
||||
``` bash
|
||||
$ fission fn getmeta --name hello
|
||||
NAME UID ENV
|
||||
hello 34234b50-12f5-11e8-85c9-42010aa00010 node
|
||||
|
||||
$ fission fn list
|
||||
NAME UID ENV EXECUTORTYPE MINSCALE MAXSCALE TARGETCPU
|
||||
hello 34234b50-12f5-11e8-85c9-42010aa00010 node poolmgr 0 1 80
|
||||
hello2 e37a46e3-12f4-11e8-85c9-42010aa00010 node newdeploy 1 5 80
|
||||
```
|
||||
@@ -0,0 +1,130 @@
|
||||
---
|
||||
title: "Packaging source code"
|
||||
draft: false
|
||||
weight: 46
|
||||
---
|
||||
|
||||
### Creating source package
|
||||
|
||||
Before you create a package, you need to create an environment with associated builder image:
|
||||
|
||||
```
|
||||
$ fission env create --name pythonsrc --image fission/python-env:latest --builder fission/python-builder:latest --mincpu 40 --maxcpu 80 --minmemory 64 --maxmemory 128 --poolsize 2
|
||||
environment 'pythonsrc' created
|
||||
```
|
||||
|
||||
Let's take a simple python function which has dependency on a python pyyaml module. We can specify the dependencies in requirements.txt and a simple command to build from source. The tree structure of directory and contents of the file looks like:
|
||||
|
||||
```
|
||||
sourcepkg/
|
||||
├── __init__.py
|
||||
├── build.sh
|
||||
├── requirements.txt
|
||||
└── user.py
|
||||
```
|
||||
And the file contents:
|
||||
```
|
||||
$ cat user.py
|
||||
import sys
|
||||
import yaml
|
||||
|
||||
document = """
|
||||
a: 1
|
||||
b:
|
||||
c: 3
|
||||
d: 4
|
||||
"""
|
||||
|
||||
def main():
|
||||
return yaml.dump(yaml.load(document))
|
||||
|
||||
$ cat requirements.txt
|
||||
pyyaml
|
||||
|
||||
$ cat build.sh
|
||||
#!/bin/sh
|
||||
pip3 install -r ${SRC_PKG}/requirements.txt -t ${SRC_PKG} && cp -r ${SRC_PKG} ${DEPLOY_PKG}
|
||||
|
||||
$zip -jr demo-src-pkg.zip sourcepkg/
|
||||
adding: __init__.py (stored 0%)
|
||||
adding: build.sh (deflated 24%)
|
||||
adding: requirements.txt (stored 0%)
|
||||
adding: user.py (deflated 25%)
|
||||
```
|
||||
Using the source archive creared in previous step, you can create a package in Fission:
|
||||
|
||||
```
|
||||
$ fission package create --sourcearchive demo-src-pkg.zip --env pythonsrc --buildcmd "./build.sh"
|
||||
Package 'demo-src-pkg-zip-8lwt' created
|
||||
```
|
||||
|
||||
Since we are working with source package, we provided the build command. Once you create the package, the build process will start and you can check the build logs by getting information of the package:
|
||||
|
||||
```
|
||||
$ fission pkg info --name demo-src-pkg-zip-8lwt
|
||||
Name: demo-src-pkg-zip-8lwt
|
||||
Environment: pythonsrc
|
||||
Status: succeeded
|
||||
Build Logs:
|
||||
Collecting pyyaml (from -r /packages/demo-src-pkg-zip-8lwt-v57qil/requirements.txt (line 1))
|
||||
Using cached PyYAML-3.12.tar.gz
|
||||
Installing collected packages: pyyaml
|
||||
Running setup.py install for pyyaml: started
|
||||
Running setup.py install for pyyaml: finished with status 'done'
|
||||
Successfully installed pyyaml-3.12
|
||||
```
|
||||
|
||||
Using the package above you can create the function. Since package already is associated with a source package, environment and build command, these will be ignored when creating a function. Only addition thing you will need to provide is the entrypoint. Assuming you hace created the route, the function should be reachable with successful output:
|
||||
|
||||
```
|
||||
$ fission fn create --name srcpy --pkg demo-src-pkg-zip-8lwt --entrypoint "user.main"
|
||||
function 'srcpy' created
|
||||
|
||||
$ curl http://$FISSION_ROUTER/srcpy
|
||||
a: 1
|
||||
b: {c: 3, d: 4}
|
||||
```
|
||||
|
||||
### Creating deployment package
|
||||
|
||||
Before you create a package you need to create an environment with the builder image:
|
||||
```
|
||||
$ fission env create --name pythondeploy --image fission/python-env:latest --builder fission/python-builder:latest --mincpu 40 --maxcpu 80 --minmemory 64 --maxmemory 128 --poolsize 2
|
||||
environment 'pythonsrc' created
|
||||
```
|
||||
|
||||
We will use a simple Python example which outputs "Hello World!" in a directory to create a deployment archive:
|
||||
|
||||
```
|
||||
$ cat testDir/hello.py
|
||||
def main():
|
||||
return "Hello, world!"
|
||||
|
||||
$zip -jr demo-deploy-pkg.zip testDir/
|
||||
|
||||
```
|
||||
Using the archive and environments created previously, you can create a package:
|
||||
|
||||
```
|
||||
$ fission package create --deployarchive demo-deploy-pkg.zip --env pythondeploy
|
||||
Package 'demo-deploy-pkg-zip-whzl' created
|
||||
```
|
||||
|
||||
Since it is a deployment archive, there is no need to build it, hence the build logs for the package will be empty:
|
||||
|
||||
```
|
||||
$ fission package info --name demo-deploy-pkg-zip-whzl
|
||||
Name: demo-deploy-pkg-zip-xlaw
|
||||
Environment: pythondeploy2
|
||||
Status: succeeded
|
||||
Build Logs:
|
||||
```
|
||||
|
||||
Finally you can create a function with the package and test the function:
|
||||
|
||||
```
|
||||
$ fission fn create --name deploypy --pkg demo-deploy-pkg-zip-whzl --entrypoint "hello.main"
|
||||
|
||||
$curl http://$FISSION_ROUTER/deploypy
|
||||
Hello, world!
|
||||
```
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: "Triggers"
|
||||
draft: false
|
||||
weight: 44
|
||||
---
|
||||
|
||||
### Create a HTTP Trigger
|
||||
|
||||
You can create a HTTP trigger with default method (GET) for a function:
|
||||
|
||||
```
|
||||
$ fission ht create --url /hello --function hello
|
||||
trigger '94cd5163-30dd-4fb2-ab3c-794052f70841' created
|
||||
```
|
||||
|
||||
### Create a Time Trigger
|
||||
|
||||
Time based triggers can be created with cron specifications:
|
||||
|
||||
```
|
||||
$ fission tt create --name halfhourly --function hello --cron "0 30 * * *"
|
||||
trigger 'halfhourly' created
|
||||
```
|
||||
|
||||
Also a more friendly syntax such "every 1m" or "@hourly" can be used to create a time based trigger.
|
||||
|
||||
```
|
||||
$ fission tt create --name minute --function hello --cron "@every 1m"
|
||||
trigger 'minute' created
|
||||
```
|
||||
|
||||
You can list time based triggers to inspect their associated function and cron specifications:
|
||||
|
||||
```
|
||||
$ fission tt list
|
||||
NAME CRON FUNCTION_NAME
|
||||
halfhourly 0 30 * * * hello
|
||||
minute @every 1m hello
|
||||
```
|
||||
|
||||
### Create a Message Queue Trigger
|
||||
|
||||
A message queue trigger invokes a function based on messages from an
|
||||
message queue. Currently, NATS and Azure Storage Queue are supported
|
||||
queues. (Kafka support is under development.)
|
||||
|
||||
```
|
||||
$ fission mqt create --name hellomsg --function hello --mqtype nats-streaming --topic newfile --resptopic newfileresponse
|
||||
trigger 'hellomsg' created
|
||||
```
|
||||
|
||||
You can list or update message queue triggers with `fission mqt list`,
|
||||
or `fission mqt update`.
|
||||
@@ -0,0 +1,158 @@
|
||||
---
|
||||
title: "Fission Workflows"
|
||||
draft: false
|
||||
weight: 70
|
||||
---
|
||||
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Fission Workflows requires the following components to be installed on your local machine:
|
||||
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
||||
- [helm](https://github.com/kubernetes/helm)
|
||||
|
||||
|
||||
Fission Workflows is deployed on top of a Kubernetes cluster.
|
||||
If you don't have a Kubernetes cluster, [here's a quick guide to set one up](../kubernetessetup).
|
||||
It also requires a [Fission](https://github.com/fission/fission) deployment to be present on your Kubernetes cluster.
|
||||
If you do not have a Fission deployment, follow [Fission's installation guide](../install).
|
||||
|
||||
**(Note that Fission Workflows 0.2.0 requires Fission 0.4.1 or higher, with the NATS component installed!)**
|
||||
|
||||
### Installing Fission Workflows
|
||||
|
||||
Fission Workflows is an add-on to Fission. You can install both
|
||||
Fission and Fission Workflows using helm charts.
|
||||
|
||||
Assuming you have your Kubernetes cluster set up with a functioning deployment of Fission 0.4.1 or higher, run the following commands:
|
||||
|
||||
```bash
|
||||
# If you haven't already, add the Fission charts repo
|
||||
$ helm repo add fission-charts https://fission.github.io/fission-charts/
|
||||
|
||||
$ helm repo update
|
||||
|
||||
# Install Fission Workflows
|
||||
$ helm install --wait -n fission-workflows fission-charts/fission-workflows --version 0.2.0
|
||||
```
|
||||
|
||||
### Creating your first workflow
|
||||
|
||||
After installing Fission and Workflows, you're all set to run a simple
|
||||
test workflow.
|
||||
With the following code snippet you will be able to deploy and run a small workflow example:
|
||||
|
||||
```bash
|
||||
# Fetch the required files, alternatively you could clone the fission-workflow repo
|
||||
$ curl https://raw.githubusercontent.com/fission/fission-workflows/0.2.0/examples/whales/fortune.sh > fortune.sh
|
||||
|
||||
$ curl https://raw.githubusercontent.com/fission/fission-workflows/0.2.0/examples/whales/whalesay.sh > whalesay.sh
|
||||
|
||||
$ curl https://raw.githubusercontent.com/fission/fission-workflows/0.2.0/examples/whales/fortunewhale.wf.yaml > fortunewhale.wf.yaml
|
||||
|
||||
#
|
||||
# Add binary environment and create two test functions on your Fission setup:
|
||||
#
|
||||
$ fission env create --name binary --image fission/binary-env
|
||||
|
||||
$ fission function create --name whalesay --env binary --deploy ./whalesay.sh
|
||||
|
||||
$ fission function create --name fortune --env binary --deploy ./fortune.sh
|
||||
|
||||
#
|
||||
# Create a workflow that uses those two functions. A workflow is just
|
||||
# a function that uses the "workflow" environment.
|
||||
#
|
||||
$ fission function create --name fortunewhale --env workflow --src ./fortunewhale.wf.yaml
|
||||
|
||||
#
|
||||
# Map an HTTP GET to your new workflow function:
|
||||
#
|
||||
$ fission route create --method GET --url /fortunewhale --function fortunewhale
|
||||
|
||||
#
|
||||
# Invoke the workflow with an HTTP request:
|
||||
#
|
||||
$ curl ${FISSION_ROUTER}/fortunewhale
|
||||
```
|
||||
|
||||
This last command, the invocation of the workflow, should return a whale saying something wise
|
||||
|
||||
```
|
||||
______________________________________
|
||||
/ Anthony's Law of Force: \
|
||||
| |
|
||||
\ Don't force it; get a larger hammer. /
|
||||
--------------------------------------
|
||||
\
|
||||
\
|
||||
\
|
||||
## .
|
||||
## ## ## ==
|
||||
## ## ## ## ## ===
|
||||
/"""""""""""""""""\___/ ===
|
||||
{ / ===-
|
||||
\______ O __/
|
||||
\ \ __/
|
||||
\____\_______/
|
||||
```
|
||||
|
||||
So what happened here?
|
||||
Let's see what the workflow consists of (for example by running `cat fortunewhale.wf.yaml`):
|
||||
|
||||
```yaml
|
||||
# This whale shows off a basic workflow that combines both Fission Functions (fortune, whalesay) and internal functions (noop)
|
||||
apiVersion: 1
|
||||
output: WhaleWithFortune
|
||||
tasks:
|
||||
InternalFuncShowoff:
|
||||
run: noop
|
||||
|
||||
GenerateFortune:
|
||||
run: fortune
|
||||
requires:
|
||||
- InternalFuncShowoff
|
||||
|
||||
WhaleWithFortune:
|
||||
run: whalesay
|
||||
inputs: "{$.Tasks.GenerateFortune.Output}"
|
||||
requires:
|
||||
- GenerateFortune
|
||||
```
|
||||
|
||||
What you see is the [YAML](http://yaml.org/)-based workflow definition of the `fortunewhale` workflow.
|
||||
A workflow consists of multiple tasks, which are steps that it needs to complete.
|
||||
Each task has a unique identifier, such as `GenerateFortune`, a reference to a Fission function in the `run` field.
|
||||
Optionally, it can contain `inputs` which allows you to specify inputs to the task,
|
||||
as well as contain `requires` which allows you to specify which tasks need to complete before this task can start.
|
||||
Finally, at the top you will find the `output` field, which specifies the task whose output is used as the workflow's output.
|
||||
|
||||
In this case, the `fortunewhale` workflow consists of a sequence of 3 tasks:
|
||||
```
|
||||
InternalFuncShowoff -> GenerateFortune -> WhaleWithFortune
|
||||
```
|
||||
First, it starts with `InternalFuncShowoff` by running `noop`, which is an *internal function* in the workflow engine.
|
||||
Internal functions are run inside of the workflow engine, which makes them run much faster at the cost of expressiveness and scalability.
|
||||
So typically, light-weight functions, such as logic or control flow operations, are good candidates to be used as internal functions.
|
||||
Besides, a minimal set of predefined internal functions, you can define internal function - there is nothing special about them.
|
||||
|
||||
After `InternalFuncShowff` completes, the `GenerateFortune` task can start as its `requires` has been fulfilled.
|
||||
It runs the `fortune` Fission function, which outputs a random piece of wisdom.
|
||||
|
||||
After `GenerateFortune` completes, the `WhaleWithFortune` task can start.
|
||||
This task uses a javascript expression in its `inputs` to reference the output of the `GenerateFortune` task.
|
||||
In the inputs of a task you can reference anything in the workflow, such as outputs, inputs, and task definitions, or just provide a constant value.
|
||||
The workflow engine invokes the `whalesay` fission function with as input the piece of wisdom, which outputs the ASCI whale that wraps the phrase.
|
||||
|
||||
Finally, with all tasks completed, the workflow engine uses the top-level `output` field to fetch the output of the `WhaleWithFortune` and return it to the user.
|
||||
As the workflow engine adheres to the Fission function specification, a Fission workflow is just another Fission Function.
|
||||
This means that you could use this workflow as a function in the `run` in other workflows.
|
||||
|
||||
### What's next?
|
||||
To learn more about the Fission Workflows system and its advanced concepts, see the [documentation on Github](https://github.com/fission/fission-workflows/tree/master/Docs).
|
||||
|
||||
Or, check out the [examples](https://github.com/fission/fission-workflows/tree/0.2.0/examples) for more example workflows.
|
||||
|
||||
If something went wrong, we'd love to help -- please [drop by the slack channel](http://slack.fission.io) and ask for help.
|
||||
|
||||
|
After Width: | Height: | Size: 5.7 KiB |
|
After Width: | Height: | Size: 32 KiB |
@@ -1,2 +0,0 @@
|
||||
.DS_Store
|
||||
public/
|
||||
@@ -1,34 +0,0 @@
|
||||
# Hugo docDock Theme
|
||||
|
||||
This repository contains a theme for [Hugo](https://gohugo.io/), based on great [Matcornic Learn theme](https://github.com/matcornic/hugo-theme-learn/).
|
||||
|
||||
Visit the [theme documentation](http://docdock.netlify.com/) to see what is going on. It is actually built with this theme.
|
||||
|
||||
# Main features
|
||||
|
||||
- Search
|
||||
- **Unlimited menu levels**
|
||||
- RevealJS presentation from markdown (embededed or fullscreen page)
|
||||
- Attachments files
|
||||
- List child pages
|
||||
- Include segment of content from one page in another (Excerpt)
|
||||
- Automatic next/prev buttons to navigate through menu entries
|
||||
- Mermaid diagram
|
||||
- Icons, Buttons, Alerts, Panels, Tip/Note/Info/Warning boxes
|
||||
- Image resizing, shadow...
|
||||
- Customizable look and feel
|
||||
|
||||
## Installation
|
||||
Navigate to your themes folder in your Hugo site and use the following commands:
|
||||
```
|
||||
$ cd themes
|
||||
$ git clone https://github.com/vjeantet/hugo-theme-docdock.git docdock
|
||||
```
|
||||
|
||||
Check that your Hugo version is minimum `0.25` with `hugo version`.
|
||||
|
||||

|
||||
|
||||
## Usage
|
||||
|
||||
- [Visit the documentation](http://docdock.netlify.com/)
|
||||
@@ -1,9 +0,0 @@
|
||||
+++
|
||||
title= "{{ replace .TranslationBaseName "-" " " | title }}"
|
||||
date= {{ .Date }}
|
||||
description = ""
|
||||
draft= true
|
||||
+++
|
||||
|
||||
Lorem Ipsum.
|
||||
Notice `draft` is set to true.
|
||||
@@ -1,46 +0,0 @@
|
||||
+++
|
||||
title = "Slide title"
|
||||
type="slide"
|
||||
|
||||
theme = "league"
|
||||
[revealOptions]
|
||||
transition= 'concave'
|
||||
controls= true
|
||||
progress= true
|
||||
history= true
|
||||
center= true
|
||||
+++
|
||||
|
||||
# Slide 1
|
||||
|
||||
___
|
||||
|
||||
## Slide 1.1
|
||||
|
||||
- Turn off alarm
|
||||
- Get out of bed
|
||||
|
||||
___
|
||||
|
||||
## Slide 1.2
|
||||
|
||||
- Eat eggs
|
||||
- Drink coffee
|
||||
|
||||
---
|
||||
|
||||
# Slide 2
|
||||
|
||||
___
|
||||
|
||||
## Slide 2.1
|
||||
|
||||
- Eat spaghetti
|
||||
- Drink wine
|
||||
|
||||
___
|
||||
|
||||
## Slide 2.2
|
||||
|
||||
- Get in bed
|
||||
- Count sheep
|
||||
@@ -1,43 +0,0 @@
|
||||
baseURL = "/"
|
||||
languageCode = "en-us"
|
||||
DefaultContentLanguage = "en"
|
||||
|
||||
title = "Docdock"
|
||||
theme = "hugo-theme-docdock"
|
||||
themesdir = "../.."
|
||||
|
||||
[params]
|
||||
editURL = "https://github.com/vjeantet/hugo-theme-docdock/edit/master/exampleSite/content/"
|
||||
noHomeIcon = false # default is false
|
||||
noSearch = false # default is false
|
||||
showVisitedLinks = true # default is false
|
||||
# themeStyle = "theme" # overide base css
|
||||
themeVariant = "" # choose theme variant "green", "gold" , "gray", "blue" (default)
|
||||
ordersectionsby = "weight" # ordersectionsby = "title"
|
||||
|
||||
[outputs]
|
||||
home = [ "HTML", "RSS", "JSON"]
|
||||
|
||||
|
||||
[[menu.shortcuts]]
|
||||
pre = "<h3>More</h3>"
|
||||
name = "<i class='fa fa-github'></i> Github repo"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/vjeantet/hugo-theme-docdock"
|
||||
weight = 10
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa fa-camera'></i> Showcases"
|
||||
url = "/showcase"
|
||||
weight = 11
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa fa-bookmark'></i> Hugo Documentation"
|
||||
identifier = "hugodoc"
|
||||
url = "https://gohugo.io/"
|
||||
weight = 20
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa fa-bullhorn'></i> Credits"
|
||||
url = "/credits"
|
||||
weight = 30
|
||||
@@ -1,6 +0,0 @@
|
||||
+++
|
||||
title = "header"
|
||||
description = ""
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
+++
|
||||
DocDock Documentation
|
||||
@@ -1,47 +0,0 @@
|
||||
+++
|
||||
title = "DocDock Theme for Hugo"
|
||||
description = ""
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
|
||||
+++
|
||||
|
||||
# Hugo docDock theme
|
||||
[Hugo-theme-docdock {{%icon fa-github%}}](https://github.com/vjeantet/hugo-theme-docdock) is a theme for Hugo, a fast and modern static website engine written in Go. Hugo is often used for blogs, **this theme is fully designed for documentation.**
|
||||
|
||||
This theme is a partial porting of the [Learn theme of matcornic {{%icon fa-github%}}](https://github.com/matcornic/hugo-theme-learn).
|
||||
|
||||
{{%panel%}}docDock works with a "page tree structure" to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "content-organisation/_index.md"%}}) {{%/panel%}}
|
||||
|
||||
## Main features
|
||||
|
||||
* [Search]({{%relref "search/_index.md" %}})
|
||||
* **Unlimited menu levels**
|
||||
* [Generate RevealJS presentation]({{%relref "page-slide.md"%}}) from markdown (embededed or fullscreen page)
|
||||
* Automatic next/prev buttons to navigate through menu entries
|
||||
* [Image resizing, shadow...]({{%relref "create-page/page-images.md" %}})
|
||||
* [Attachments files]({{%relref "shortcodes/attachments.md" %}})
|
||||
* [List child pages]({{%relref "shortcodes/children/_index.md" %}})
|
||||
* [Excerpt]({{%relref "shortcodes/excerpt.md"%}}) ! Include segment of content from one page in another
|
||||
* [Mermaid diagram]({{%relref "shortcodes/mermaid.md" %}}) (flowchart, sequence, gantt)
|
||||
* [Icons]({{%relref "shortcodes/icon.md" %}}), [Buttons]({{%relref "shortcodes/button.md" %}}), [Alerts]({{%relref "shortcodes/alert.md" %}}), [Panels]({{%relref "shortcodes/panel.md" %}}), [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.md" %}}), [Expand]({{%relref "shortcodes/expand.md" %}})
|
||||
* [customizable look and feel]({{%relref "content-organisation/customize-style/_index.md"%}}), [theme variants]({{%relref "content-organisation/customize-style/theme-variants.md"%}})
|
||||
|
||||
|
||||
|
||||
|
||||

|
||||
|
||||
## Contribute to this documentation
|
||||
Feel free to update this content, just click the **Edit this page** link displayed on top right of each page, and pullrequest it
|
||||
{{%alert%}}Your modification will be deployed automatically when merged.{{%/alert%}}
|
||||
|
||||
|
||||
## Documentation website
|
||||
This current documentation has been statically generated with Hugo with a simple command : `hugo -t docdock` -- source code is [available here at GitHub {{%icon fa-github%}}](https://github.com/vjeantet/hugo-theme-docDock)
|
||||
|
||||
{{% panel theme="success" header="Automated deployments" footer="Netlify builds, deploys, and hosts frontends." %}}
|
||||
Automatically published and hosted thanks to [Netlify](https://www.netlify.com/).
|
||||
|
||||
Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)
|
||||
{{% /panel %}}
|
||||
|
||||
@@ -1,138 +0,0 @@
|
||||
+++
|
||||
title = "Content Organisation"
|
||||
description = ""
|
||||
weight = 20
|
||||
+++
|
||||
|
||||
With **Hugo**, pages are the core of your site. Organize your site like any other Hugo project. **Magic occurs with the nested sections implemention done in v0.22 of hugo (congrats @bep)**.
|
||||
|
||||
With docdock, **Each content page composes the menu**, they shape the structure of your website.
|
||||
|
||||
To link pages to each other, place them in a folders hierarchy
|
||||
|
||||
```
|
||||
content
|
||||
├── level-one
|
||||
│ ├── level-two
|
||||
│ │ ├── level-three
|
||||
│ │ │ ├── level-four
|
||||
│ │ │ │ ├── _index.md
|
||||
│ │ │ │ ├── page-4-a.md
|
||||
│ │ │ │ ├── page-4-b.md
|
||||
│ │ │ │ └── page-4-c.md
|
||||
│ │ │ ├── _index.md
|
||||
│ │ │ ├── page-3-a.md
|
||||
│ │ │ ├── page-3-b.md
|
||||
│ │ │ └── page-3-c.md
|
||||
│ │ ├── _index.md
|
||||
│ │ ├── page-2-a.md
|
||||
│ │ ├── page-2-b.md
|
||||
│ │ └── page-2-c.md
|
||||
│ ├── _index.md
|
||||
│ ├── page-1-a.md
|
||||
│ ├── page-1-b.md
|
||||
│ └── page-1-c.md
|
||||
├── _index.md
|
||||
└── page-top.md
|
||||
```
|
||||
|
||||
|
||||
{{%alert info %}} **_index.md** is required in each folder, it's your "folder home page"{{%/alert%}}
|
||||
|
||||
### Add header to a menu entry
|
||||
|
||||
in the page frontmatter, add a `head` param to insert any HTML code before the menu entry:
|
||||
|
||||
example to display a "Hello"
|
||||
|
||||
+++
|
||||
title = "Github repo"
|
||||
head ="<label>Hello</label> "
|
||||
+++
|
||||
|
||||
|
||||
|
||||
### Add icon to a menu entry
|
||||
|
||||
in the page frontmatter, add a `pre` param to insert any HTML code before the menu label:
|
||||
|
||||
example to display a github icon
|
||||
|
||||
+++
|
||||
title = "Github repo"
|
||||
pre ="<i class='fa fa-github'></i> "
|
||||
+++
|
||||
|
||||

|
||||
|
||||
<!-- ### Customize menu entry label
|
||||
|
||||
Add a `name` param next to `[menu.main]`
|
||||
|
||||
+++
|
||||
[menu.main]
|
||||
parent = ""
|
||||
identifier = "repo"
|
||||
pre ="<i class='fa fa-github'></i> "
|
||||
name = "Github repo"
|
||||
+++ -->
|
||||
|
||||
<!-- ### Create a page redirector
|
||||
Add a `url` param next to `[menu.main]`
|
||||
|
||||
+++
|
||||
[menu.main]
|
||||
parent = "page"
|
||||
identifier = "page-images"
|
||||
weight = 23
|
||||
url = "/shortcode/image/"
|
||||
+++
|
||||
|
||||
{{%alert info%}}Look at the menu "Create Page/About images" which redirects to "Shortcodes/image{{%/alert%}}
|
||||
-->
|
||||
### Order sibling menu/page entries
|
||||
|
||||
in your frontmatter add `weight` param with a number to order.
|
||||
|
||||
+++
|
||||
title="My page"
|
||||
weight = 4
|
||||
+++
|
||||
|
||||
{{%info%}}add `ordersectionsby = "title"` in your config.toml to order menu entries by title{{%/info%}}
|
||||
|
||||
|
||||
### Hide a menu entry
|
||||
|
||||
in your frontmatter add `hidden=true` param.
|
||||
|
||||
+++
|
||||
title="My page"
|
||||
hidden = true
|
||||
+++
|
||||
|
||||
|
||||
### Unfolded menu entry by default
|
||||
|
||||
One or more menuentries can be displayed unfolded by default. (like the "Getting start" menu entry in this website)
|
||||
|
||||
in your frontmatter add `alwaysopen=true` param.
|
||||
example :
|
||||
|
||||
```
|
||||
title = "Getting start"
|
||||
description = ""
|
||||
weight = 1
|
||||
alwaysopen = true
|
||||
```
|
||||
|
||||
### Folder structure and file name
|
||||
|
||||
Content organization **is** your `content` folder structure.
|
||||
|
||||
### Homepage
|
||||
|
||||
Find out how to [customize homepage]({{%relref "homepage.md"%}})
|
||||
|
||||
|
||||
|
||||
@@ -1,40 +0,0 @@
|
||||
+++
|
||||
title = "Customize website look and feel"
|
||||
Weight=3
|
||||
+++
|
||||
|
||||
You can change the style and behavior of the theme without touching it.
|
||||
|
||||
* inject your own html, css or js into the page
|
||||
* overide existing css or js with your own files
|
||||
|
||||
## Inject your HTML
|
||||
|
||||
### into the \<head\> part of each page :
|
||||
|
||||
Create a `custom-head.html` into a `layouts/partials` folder next to the content folder
|
||||
|
||||
> * content/
|
||||
> * layouts/
|
||||
> * partials/
|
||||
> * custom-head.html
|
||||
|
||||
now feel free to add the JS, CSS, HTML code you want :)
|
||||
|
||||
### at the end of the body part of each page :
|
||||
|
||||
Create a `custom-footer.html` into a `layouts/partials` folder next to the content folder
|
||||
|
||||
> * content/
|
||||
> * layouts/
|
||||
> * partials/
|
||||
> * custom-footer.html
|
||||
|
||||
now feel free to add the JS, CSS, HTML code you want :)
|
||||
|
||||
## overide existing CSS or JS
|
||||
|
||||
Create the matching file in your static folder, hugo will use yours instead of the theme's one.
|
||||
Example :
|
||||
|
||||
create a theme.css and place it into `static/css/` to fully overide docdock's theme.css
|
||||
@@ -1,35 +0,0 @@
|
||||
+++
|
||||
title = "Theme variants"
|
||||
description = "change theme style/colors"
|
||||
+++
|
||||
|
||||
In site configuration file, you can set a variant name of this theme to load a specific css, with different color specifications.
|
||||
|
||||
add a param `themeVariant = "VARIANT_NAME"` in the `[params]` part of config.toml file.
|
||||
|
||||
{{%info%}}Available variants change only colors at this moment{{%/info%}}
|
||||
|
||||
|
||||
## Variant "gray"
|
||||
```
|
||||
[params]
|
||||
themeVariant = "gray"
|
||||
```
|
||||
|
||||

|
||||
|
||||
## Variant "gold"
|
||||
```
|
||||
[params]
|
||||
themeVariant = "gold"
|
||||
```
|
||||
|
||||

|
||||
|
||||
## Variant "green"
|
||||
```
|
||||
[params]
|
||||
themeVariant = "green"`
|
||||
```
|
||||
|
||||

|
||||
@@ -1,28 +0,0 @@
|
||||
+++
|
||||
title = "Extra menu entries"
|
||||
date = "2017-04-29T18:36:24+02:00"
|
||||
Weight=2
|
||||
+++
|
||||
|
||||
You can define additional menu entries in the navigation menu without any link to content.
|
||||
|
||||
Edit the website configuration `config.toml` and add a `[[menu.shortcuts]]` entry for each link your want to add.
|
||||
|
||||
|
||||
Example from the current website, **note the `pre` param** which allows you to insert HTML code and used here to separate content's menu from this "static" menu
|
||||
|
||||
[[menu.shortcuts]]
|
||||
pre = "<h3>More</h3>"
|
||||
name = "<i class='fa fa-github'></i> Github repo"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/vjeantet/hugo-theme-docdock"
|
||||
weight = 1
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa fa-bookmark'></i> Hugo Documentation"
|
||||
identifier = "hugodoc"
|
||||
url = "https://gohugo.io/"
|
||||
weight = 2
|
||||
|
||||
|
||||
[{{%icon circle-arrow-right%}} Read more about hugo and menu here](https://gohugo.io/extras/menus/)
|
||||
@@ -1,12 +0,0 @@
|
||||
+++
|
||||
title = "Logo placeholder"
|
||||
description = ""
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
Weight=1
|
||||
+++
|
||||
|
||||
Create a `_header.md` page in content folder. Its content is what you get in the logo placeholder (top left of the screen).
|
||||
|
||||
{{%alert info%}}**Tip :** you can add a image, a combobox with links to other documentation....{{%/alert%}}
|
||||
|
||||
{{%alert info%}}**Tip 2 :** look at [ extra static menu]({{%relref "extramenu.md"%}}) if you want to add links to other website in this sidebar{{%/alert%}}
|
||||
@@ -1,54 +0,0 @@
|
||||
+++
|
||||
title = "Create Page"
|
||||
description = ""
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
creatordisplayname = "Valere JEANTET"
|
||||
creatoremail = "valere.jeantet@gmail.com"
|
||||
lastmodifierdisplayname = "Valere JEANTET"
|
||||
lastmodifieremail = "valere.jeantet@gmail.com"
|
||||
tags = ["tag1","tag2"]
|
||||
weight = 10
|
||||
pre ="<i class='fa fa-edit'></i> "
|
||||
|
||||
+++
|
||||
|
||||
|
||||
Hugo-theme-docdock defines two types of pages. _Default_ and _Slide_.
|
||||
|
||||
* **Default** is the common page like the current one you are reading.
|
||||
* **Slide** is a page that use the full screen to display its markdown content as a [reveals.js presentation](http://lab.hakim.se/reveal-js/).
|
||||
* **HomePage** is a special content that will be displayed as home page content.
|
||||
|
||||
To tell Hugo-theme-docdock to consider a page as a slide, just add a `type="slide"`in then frontmatter of your file. [{{%icon circle-arrow-right%}}read more on page as slide]({{%relref "page-slide.md"%}})
|
||||
|
||||
|
||||
Hugo-theme-docdock provides archetypes to help you create this kind of pages.
|
||||
|
||||
|
||||
## Front Matter
|
||||
Each Hugo page has to define a Front Matter in yaml, toml or json.
|
||||
|
||||
Hugo-theme-docdock uses the following parameters on top of the existing ones :
|
||||
|
||||
+++
|
||||
# Type of content, set "slide" to display it fullscreen with reveal.js
|
||||
type="page"
|
||||
|
||||
# Creator's Display name
|
||||
creatordisplayname = "Valere JEANTET"
|
||||
# Creator's Email
|
||||
creatoremail = "valere.jeantet@gmail.com"
|
||||
# LastModifier's Display name
|
||||
lastmodifierdisplayname = "Valere JEANTET"
|
||||
# LastModifier's Email
|
||||
lastmodifieremail = "valere.jeantet@gmail.com"
|
||||
+++
|
||||
|
||||
|
||||
## Ordering
|
||||
|
||||
Hugo provides a flexible way to handle order for your pages.
|
||||
|
||||
The simplest way is to use `weight` parameter in the front matter of your page.
|
||||
|
||||
[{{%icon circle-arrow-right%}}Read more on content organization]({{%relref "content-organisation/_index.md"%}})
|
||||
@@ -1,8 +0,0 @@
|
||||
+++
|
||||
title = "Home page"
|
||||
description = ""
|
||||
date = "2017-04-28T18:36:24+02:00"
|
||||
tags = ["tag1","tag2"]
|
||||
+++
|
||||
|
||||
To tell Hugo-theme-docdock to consider a page as homepage's content, just create a content file named `_index.md` in content folder.
|
||||
@@ -1,48 +0,0 @@
|
||||
+++
|
||||
title = "My Slide ! fullscreen"
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
type="slide"
|
||||
hidden=true
|
||||
|
||||
theme = "league"
|
||||
[revealOptions]
|
||||
transition= 'concave'
|
||||
controls= true
|
||||
progress= true
|
||||
history= false
|
||||
center= true
|
||||
+++
|
||||
|
||||
# In the morning
|
||||
|
||||
___
|
||||
|
||||
## Getting up
|
||||
|
||||
- Turn off alarm
|
||||
- Get out of bed
|
||||
|
||||
___
|
||||
|
||||
## Breakfast
|
||||
|
||||
- Eat eggs
|
||||
- Drink coffee
|
||||
|
||||
---
|
||||
|
||||
# In the evening
|
||||
|
||||
___
|
||||
|
||||
## Dinner
|
||||
|
||||
- Eat spaghetti
|
||||
- Drink wine
|
||||
|
||||
___
|
||||
|
||||
## Going to sleep
|
||||
|
||||
- Get in bed
|
||||
- Count sheep
|
||||
@@ -1,28 +0,0 @@
|
||||
+++
|
||||
title = "About images"
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
+++
|
||||
|
||||
Images have a similar syntax to links but include a preceding exclamation point.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
## Resizing image
|
||||
|
||||
Add HTTP parameters `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`).
|
||||
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
|
||||
## Add CSS classes
|
||||
|
||||
Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow` and `border` are available but you could define other ones.
|
||||
|
||||

|
||||
|
||||

|
||||
@@ -1,114 +0,0 @@
|
||||
+++
|
||||
title = "Present a Slide"
|
||||
description = ""
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
+++
|
||||
|
||||
A basic md content page can be rendered as a reveal.js presentation full screen.
|
||||
|
||||
{{%alert info%}}You can, also, **embed presentation in a page** as a small box, using the [revealjs]({{% relref "shortcodes/revealjs.md"%}}) shortcode in your md file.{{%/alert%}}
|
||||
|
||||
|
||||
## Formating
|
||||
Use your common Markdown syntax you use in Hugo, don't forget, you can put html tags too.
|
||||
|
||||
{{%notice info %}} Special syntax (in html comment) is available for adding attributes to Markdown elements. This is useful for fragments, amongst other things.
|
||||
{{%/notice%}}
|
||||
|
||||
Please read the [{{%icon book%}} doc from hakimel](https://github.com/hakimel/reveal.js/#instructions)
|
||||
|
||||
|
||||
## Options
|
||||
In the frontmatter of your page file, set **type** and **revealOptions** params
|
||||
|
||||
Your content will be served as a fullscreen revealjs presentation and revealOptions will be used to ajust its behaviour.
|
||||
|
||||
+++
|
||||
title = "Test slide"
|
||||
type="slide"
|
||||
|
||||
theme = "league"
|
||||
[revealOptions]
|
||||
transition= 'concave'
|
||||
controls= true
|
||||
progress= true
|
||||
history= true
|
||||
center= true
|
||||
+++
|
||||
|
||||
[read more about reveal options here](https://github.com/hakimel/reveal.js/#configuration)
|
||||
|
||||
|
||||
## Slide Delimiters
|
||||
When creating the content for your slideshow presentation within content markdown file you need to be able to distinguish between one slide and the next. This is achieved very simply using a convention within Markdown that indicates the start of each new slide.
|
||||
|
||||
As both horizontal and vertical slides are supported by reveal.js each has it's own unique delimiter.
|
||||
|
||||
To denote the start of a horizontal slide simply add the following delimiter in your Markdown:
|
||||
|
||||
---
|
||||
|
||||
|
||||
To denote the start of a vertical slide simply add the following delimiter in your Markdown:
|
||||
|
||||
___
|
||||
|
||||
By using a combination of horizontal and vertical slides you can customize the navigation within your slideshow presentation. Typically vertical slides are used to present information below a top-level horizontal slide.
|
||||
|
||||
|
||||
|
||||
For example, a very simple slideshow presentation can be created as follows
|
||||
|
||||
```
|
||||
+++
|
||||
|
||||
title = "test"
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
type="slide"
|
||||
|
||||
theme = "league"
|
||||
[revealOptions]
|
||||
transition= 'concave'
|
||||
controls= true
|
||||
progress= true
|
||||
history= true
|
||||
center= true
|
||||
+++
|
||||
|
||||
# In the morning
|
||||
|
||||
___
|
||||
|
||||
## Getting up
|
||||
|
||||
- Turn off alarm
|
||||
- Get out of bed
|
||||
|
||||
___
|
||||
|
||||
## Breakfast
|
||||
|
||||
- Eat eggs
|
||||
- Drink coffee
|
||||
|
||||
---
|
||||
|
||||
# In the evening
|
||||
|
||||
___
|
||||
|
||||
## Dinner
|
||||
|
||||
- Eat spaghetti
|
||||
- Drink wine
|
||||
|
||||
___
|
||||
|
||||
## Going to sleep
|
||||
|
||||
- Get in bed
|
||||
- Count sheep
|
||||
|
||||
```
|
||||
|
||||
[{{%icon expand%}}click here to view this page rendered]({{%relref "myslide.md"%}})
|
||||
@@ -1,12 +0,0 @@
|
||||
+++
|
||||
title = "Getting start"
|
||||
description = ""
|
||||
weight = 1
|
||||
alwaysopen = true
|
||||
+++
|
||||
|
||||
## Requirements
|
||||
|
||||
Download [Hugo binary](https://gohugo.io/overview/installing/) for your OS (Windows, Linux, Mac) : it’s that simple
|
||||
|
||||
{{%children style="h2" description="true"%}}
|
||||
@@ -1,26 +0,0 @@
|
||||
+++
|
||||
title = "Configuration"
|
||||
description = ""
|
||||
weight = 2
|
||||
+++
|
||||
|
||||
When building the website, you can set a theme by using `--theme` option. We suggest you to edit your configuration file and set the theme by default. Example with `config.toml` format.
|
||||
<!--more-->
|
||||
```
|
||||
theme = "docdock"
|
||||
```
|
||||
|
||||
## Search index generation
|
||||
|
||||
Add the follow line in the same `config.toml` file.
|
||||
|
||||
```
|
||||
[outputs]
|
||||
home = [ "HTML", "RSS", "JSON"]
|
||||
```
|
||||
|
||||
LUNRJS search index file will be generated on content changes.
|
||||
|
||||
## Your website's content
|
||||
|
||||
Find out how to [create]({{%relref "create-page/_index.md"%}}) and [organize your content]({{%relref "content-organisation/_index.md"%}}) quickly and intuitively.
|
||||
@@ -1,31 +0,0 @@
|
||||
+++
|
||||
title = "Installation"
|
||||
description = ""
|
||||
weight = 1
|
||||
+++
|
||||
|
||||
{{% alert theme="warning" %}}HUGO **v0.25** minimum required to use this theme{{%/alert%}}
|
||||
|
||||
The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you to train by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/).
|
||||
<!--more-->
|
||||
|
||||
## Create Your Documentation
|
||||
|
||||
Hugo provides a `new` command to create a new website.
|
||||
|
||||
$ hugo new site <new_website>
|
||||
|
||||
## Install The Theme
|
||||
|
||||
Install the **Hugo-theme-docdock** theme by following this
|
||||
|
||||
Switch into the themes directory and download the theme
|
||||
|
||||
$ cd themes
|
||||
$ git clone https://github.com/vjeantet/hugo-theme-docdock.git docdock
|
||||
|
||||
Alternatively, you can [{{%icon download%}} download the theme as .zip](https://github.com/vjeantet/hugo-theme-docdock/archive/master.zip) file and extract it in the themes directory
|
||||
|
||||
## Basic Configuration
|
||||
|
||||
[Follow instructions here]({{%relref "configuration.md"%}})
|
||||
@@ -1,11 +0,0 @@
|
||||
+++
|
||||
title = "About the Search Engine"
|
||||
description = ""
|
||||
weight = 40
|
||||
+++
|
||||
|
||||
**Nothing to do on your side. :-)**
|
||||
|
||||
Docdock theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.
|
||||
|
||||
{{%note%}}hugo generate lunrjs index.json at the root of `public` folder. <br/>When you build the site with `hugo server`, hugo generates it internally and of course it don't show up in the filesystem{{%/note%}}
|
||||
@@ -1,10 +0,0 @@
|
||||
+++
|
||||
title = "Shortcodes"
|
||||
description = ""
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
weight = 30
|
||||
+++
|
||||
|
||||
A bunch of Shortcodes are available with this theme :
|
||||
|
||||
{{%children style="h2" description="true" %}}
|
||||
@@ -1,30 +0,0 @@
|
||||
+++
|
||||
title = "alert"
|
||||
description = "The alert shortcode allows you to highlight information in your page."
|
||||
+++
|
||||
|
||||
The `alert` shortcode allow you to highlight information in your page. They create a colored box surrounding your text, like this:
|
||||
|
||||
{{%alert%}}**This is** an alert !{{%/alert%}}
|
||||
## Usage
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|:--|:--|:--|
|
||||
| theme | `info` | `success`, `info`,`warning`,`danger` |
|
||||
|
||||
{{%alert info%}}
|
||||
**Tips :** setting only the theme as argument works too :
|
||||
`{{%/*alert warning*/%}}` instead of `{{%/*alert theme="warning"*/%}}`
|
||||
{{%/alert%}}
|
||||
|
||||
## Basic examples
|
||||
|
||||
{{%/* alert theme="info" */%}}**this** is a text{{%/* /alert */%}}
|
||||
{{%/* alert theme="success" */%}}**Yeahhh !** is a text{{%/* /alert */%}}
|
||||
{{%/* alert theme="warning" */%}}**Be carefull** is a text{{%/* /alert */%}}
|
||||
{{%/* alert theme="danger" */%}}**Beware !** is a text{{%/* /alert */%}}
|
||||
|
||||
{{% alert theme="info"%}}**this** is an info{{% /alert %}}
|
||||
{{% alert theme="success" %}}**Yeahhh !** is an success{{% /alert %}}
|
||||
{{% alert theme="warning" %}}**Be carefull** is a warning{{% /alert %}}
|
||||
{{% alert theme="danger" %}}**Beware !** is a danger{{% /alert %}}
|
||||
@@ -1,37 +0,0 @@
|
||||
+++
|
||||
title = "button"
|
||||
description = "Display an actionable button in your page."
|
||||
+++
|
||||
|
||||
Display an actionable button in your page.
|
||||
|
||||
{{<button align="center" href="#" theme="warning" >}} This is a warning button {{< /button >}}
|
||||
|
||||
## Usage
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|:--|:--|:--|
|
||||
| href | "" | The location href to link to |
|
||||
| align | "center" | horizontal align button on page |
|
||||
| theme | `primary` | `default`, `primary` , `success`,`info`,`warning`,`danger` |
|
||||
|
||||
The inner text you place in short code will be displayed as the _button text_
|
||||
|
||||
## Demo
|
||||
|
||||
{{</* button href="https://google.com" */>}} go to google {{</* /button */>}}
|
||||
{{</* button href="https://google.com" theme="success" */>}} Success {{</* /button */>}}
|
||||
{{</* button href="https://google.com" theme="info" */>}} Info {{</* /button */>}}
|
||||
{{</* button href="https://google.com" theme="warning" */>}} Warning {{</* /button */>}}
|
||||
{{</* button href="https://google.com" theme="danger" */>}} Danger ! {{</* /button */>}}
|
||||
{{</* button href="https://google.com" theme="default" */>}} Danger ! {{</* /button */>}}
|
||||
|
||||
{{<button href="https://google.com" >}} go to google {{< /button >}}
|
||||
{{<button href="https://google.com" theme="success">}} Success {{< /button >}}
|
||||
{{<button href="https://google.com" theme="info">}} Info {{< /button >}}
|
||||
{{<button href="https://google.com" theme="warning">}} Warning {{< /button >}}
|
||||
{{<button href="https://google.com" theme="danger">}} Danger ! {{< /button >}}
|
||||
{{<button href="https://google.com" theme="default">}} Danger ! {{< /button >}}
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
+++
|
||||
title = "page 1-1"
|
||||
description = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
@@ -1,22 +0,0 @@
|
||||
+++
|
||||
title = "excerpt-include"
|
||||
description = ""
|
||||
+++
|
||||
|
||||
The Excerpt Include shortcode is used to display 'excerpted' (that is, a segment of) content from one page in another.
|
||||
Before you can use this shortcode, the excerpt must have been defined using the Excerpt shortcode. {{%alert info%}}Note that you can have more than one Excerpt Include shortcode on a page (although you can have only one Excerpt shortcode on a page).{{%/alert%}}
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|:--|:--|:--|
|
||||
| filename | **required** | Type the filename of the page that contains the excerpt to be displayed.<br/>Path is relative to the content folder|
|
||||
| panel | none | Determines whether docDock will display a panel around the excerpted content. The panel includes the given panel's value and the border of the panel. By default, the panel and title are not shown.|
|
||||
|
||||
## Demo
|
||||
The paragraph below shows an example of an Excerpt Include shortcode, containing content from an excerpt which we have defined on the Excerpt shortcode page. On the Excerpt Include shortcode below, we have set the options to show both the title of the page and the panel surrounding the content.
|
||||
|
||||
{{%/*excerpt-include filename="shortcodes/excerpt.md" panel="From excerpt page" /*/%}}
|
||||
|
||||
{{%excerpt-include filename="shortcodes/excerpt.md" panel="From excerpt page" /%}}
|
||||
@@ -1,39 +0,0 @@
|
||||
+++
|
||||
title = "excerpt"
|
||||
description = "The Excerpt shortcode is used to mark a part of a page's content for re-use."
|
||||
+++
|
||||
|
||||
The Excerpt shortcode is used to mark a part of a page's content for re-use. Defining an excerpt enables other shortcodes, such as the excerpt-include shortcode, to display the marked content elsewhere.
|
||||
|
||||
{{%alert warning%}}You can only define one excerpt per page. In other words, you can only add the Excerpt shortcode once to a page.{{%/alert%}}
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|:--|:--|:--|
|
||||
| hidden | "false" | Controls whether the page content contained in the Excerpt shortcode placeholder is displayed on the page.{{%alert warning%}}Note that this option affects only the page that contains the Excerpt shortcode. It does not affect any pages where the content is reused.{{%/alert%}} |
|
||||
|
||||
## Demo
|
||||
|
||||
{{%/*excerpt*/%}}
|
||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation **ullamco** laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in _reprehenderit in voluptate_
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
{{%/* /excerpt*/%}}
|
||||
|
||||
{{%excerpt%}}
|
||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation **ullamco** laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in _reprehenderit in voluptate_
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
{{% /excerpt%}}
|
||||
|
||||
|
||||
|
||||
{{%alert info%}}See re use example with [excerpt-include shortcode]({{%relref "shortcodes/excerpt-include.md"%}}){{%/alert%}}
|
||||
@@ -1,61 +0,0 @@
|
||||
+++
|
||||
title = "notice"
|
||||
description = "Disclaimers to help you structure your page"
|
||||
+++
|
||||
|
||||
The notice shortcode shows 4 types of disclaimers to help you structure your page.
|
||||
|
||||
|
||||
## Note
|
||||
|
||||
{{%/* notice note */%}}
|
||||
A notice disclaimer
|
||||
{{%/* /notice */%}}
|
||||
|
||||
renders as
|
||||
|
||||
{{% notice note %}}
|
||||
A notice disclaimer
|
||||
{{% /notice %}}
|
||||
|
||||
|
||||
## Info
|
||||
|
||||
{{%/* notice info */%}}
|
||||
An information disclaimer
|
||||
{{%/* /notice */%}}
|
||||
|
||||
renders as
|
||||
|
||||
{{% notice info %}}
|
||||
An information disclaimer
|
||||
{{% /notice %}}
|
||||
|
||||
|
||||
|
||||
## Tip
|
||||
|
||||
{{%/* notice tip */%}}
|
||||
A tip disclaimer
|
||||
{{%/* /notice */%}}
|
||||
|
||||
renders as
|
||||
|
||||
{{% notice tip %}}
|
||||
A tip disclaimer
|
||||
{{% /notice %}}
|
||||
|
||||
|
||||
|
||||
## Warning
|
||||
|
||||
{{%/* notice warning */%}}
|
||||
An warning disclaimer
|
||||
{{%/* /notice */%}}
|
||||
|
||||
renders as
|
||||
|
||||
{{% notice warning %}}
|
||||
An warning disclaimer
|
||||
{{% /notice %}}
|
||||
|
||||
@@ -1,60 +0,0 @@
|
||||
+++
|
||||
title = "panel"
|
||||
description = "Allow you to highlight information or put it in a box."
|
||||
+++
|
||||
|
||||
|
||||
|
||||
{{% panel theme="success" header="The panel shortcode" %}}Allow you to highlight information or put it in a box. They create a colored box surrounding your text{{% /panel %}}
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|:--|:--|:--|
|
||||
| header | none | The title of the panel. If specified, this title will be displayed in its own header row. |
|
||||
| footer | none | the footer of the panel. If specified, this text will be displayed in its own row |
|
||||
| theme | `primary` | `default`,`primary`,`info`,`success`,`warning`,`danger` |
|
||||
|
||||
## Basic example
|
||||
|
||||
By default :
|
||||
|
||||
{{%/* panel */%}}this is a panel text{{%/* /panel */%}}
|
||||
|
||||
{{%panel%}}this is a panel text{{%/panel%}}
|
||||
|
||||
## Panel with heading
|
||||
|
||||
Easily add a heading container to your panel with `header` parameter. You may apply any theme.
|
||||
|
||||
{{%/* panel theme="danger" header="panel title" */%}}this is a panel text{{%/* /panel */%}}
|
||||
|
||||
{{% panel theme="danger" header="panel title" %}}this is a panel text{{% /panel %}}
|
||||
|
||||
{{%/* panel theme="success" header="panel title" */%}}this is a panel text{{%/* /panel */%}}
|
||||
|
||||
{{% panel theme="success" header="panel title" %}}this is a panel text{{% /panel %}}
|
||||
|
||||
## Panel with footer
|
||||
Wrap a secondary text in footer.
|
||||
|
||||
{{%/* panel footer="panel footer" */%}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{%/* /panel */%}}
|
||||
|
||||
{{% panel footer="panel footer" %}}
|
||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
{{% /panel %}}
|
||||
|
||||
## Themes
|
||||
|
||||
{{% panel theme="success" header="Success theme" %}}this is a panel text{{% /panel %}}
|
||||
{{% panel theme="default" header="default theme" %}}this is a panel text{{% /panel %}}
|
||||
{{% panel theme="primary" header="primary theme" %}}this is a panel text{{% /panel %}}
|
||||
{{% panel theme="info" header="info theme" %}}this is a panel text{{% /panel %}}
|
||||
{{% panel theme="warning" header="warning theme" %}}this is a panel text{{% /panel %}}
|
||||
{{% panel theme="danger" header="danger theme" %}}this is a panel text{{% /panel %}}
|
||||
@@ -1,74 +0,0 @@
|
||||
+++
|
||||
title = "revealjs"
|
||||
slug = "revealjs"
|
||||
description = "present content as a reveal.js slide"
|
||||
+++
|
||||
|
||||
This shortcode will format the enclosed markdow to render it with [reveal.js](http://lab.hakim.se/reveal-js/) at runtime (client-side)
|
||||
|
||||
Read more on [revealjs github repo](https://github.com/hakimel/reveal.js/#markdown).
|
||||
|
||||
## Usage
|
||||
|
||||
`revealjs` can use the following named parameters :
|
||||
|
||||
* theme
|
||||
* transition
|
||||
* controls
|
||||
* progress
|
||||
* history
|
||||
* center
|
||||
|
||||
|
||||
{{%warning title="Important" %}}Even if the enclosed content is a mardown, use `<` shortcode notation instead of the `%` notation {{%/warning %}}
|
||||
|
||||
### Content formating and slide delimiters
|
||||
|
||||
[read more on this here]({{% relref "page-slide.md"%}})
|
||||
|
||||
## Demo
|
||||
|
||||
{{<revealjs theme="moon" progress="true">}}
|
||||
|
||||
# In the morning
|
||||
|
||||
___
|
||||
|
||||
|
||||
## Getting up
|
||||
|
||||
- Turn off alarm
|
||||
- Get out of bed
|
||||
|
||||
___
|
||||
|
||||
## Breakfast
|
||||
|
||||
- Eat eggs
|
||||
- Drink coffee
|
||||
|
||||
---
|
||||
|
||||
# In the evening
|
||||
|
||||
___
|
||||
|
||||
## Dinner
|
||||
|
||||
- Eat spaghetti
|
||||
- Drink wine
|
||||
|
||||
___
|
||||
|
||||
## Going to sleep
|
||||
|
||||
- Get in bed
|
||||
- Count sheep
|
||||
|
||||
{{</revealjs>}}
|
||||
|
||||
## Source :
|
||||
|
||||
* [{{%icon "sunglasses" %}} click here to view raw content](https://raw.githubusercontent.com/vjeantet/hugo-theme-docdock/master/exampleSite/content/shortcodes/revealjs.md)
|
||||
editURL
|
||||
|
||||
@@ -1,11 +0,0 @@
|
||||
+++
|
||||
title = "Docdock-built Sites"
|
||||
description = "Hugo-built Sites with docdock theme"
|
||||
+++
|
||||
|
||||
|
||||
|
||||
|
||||
#### [https://invincible.site/](https://invincible.site/) by [@shazic](https://github.com/shazic)
|
||||

|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
<center>
|
||||
<!-- Place this tag where you want the button to render. -->
|
||||
<a class="github-button" href="https://github.com/vjeantet/hugo-theme-docdock/archive/master.zip" data-icon="octicon-cloud-download" aria-label="Download vjeantet/hugo-theme-docdock on GitHub">Download</a>
|
||||
|
||||
<!-- Place this tag where you want the button to render. -->
|
||||
<a class="github-button" href="https://github.com/vjeantet/hugo-theme-docdock" data-icon="octicon-star" data-show-count="false" aria-label="Star vjeantet/hugo-theme-docdock on GitHub">Star</a>
|
||||
|
||||
<!-- Place this tag where you want the button to render. -->
|
||||
<a class="github-button" href="https://github.com/vjeantet/hugo-theme-docdock/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork vjeantet/hugo-theme-docdock on GitHub">Fork</a>
|
||||
|
||||
</center>
|
||||
<!-- Place this tag in your head or just before your close body tag. -->
|
||||
<script async defer src="https://buttons.github.io/buttons.js"></script>
|
||||
|
Before Width: | Height: | Size: 9.0 KiB |
|
Before Width: | Height: | Size: 1.3 MiB |
|
Before Width: | Height: | Size: 185 KiB |
|
Before Width: | Height: | Size: 140 KiB |
|
Before Width: | Height: | Size: 173 KiB |
@@ -1,35 +0,0 @@
|
||||
[create-header-md]
|
||||
other = "Create a _header.md to customize this"
|
||||
|
||||
[Search-placeholder]
|
||||
other = "Search..."
|
||||
|
||||
[Clear-History]
|
||||
other = "Clear History"
|
||||
|
||||
[Page]
|
||||
other = "Page"
|
||||
|
||||
[Next-Pages]
|
||||
other = "Next Pages"
|
||||
|
||||
[Previous-Pages]
|
||||
other = "Previous Pages"
|
||||
|
||||
[pagination-on]
|
||||
other = "of"
|
||||
|
||||
[Attachments-label]
|
||||
other = "Attachments"
|
||||
|
||||
[title-404]
|
||||
other = "Error"
|
||||
|
||||
[message-404]
|
||||
other = "Woops. Looks like this page doesn't exist."
|
||||
|
||||
[Go-to-homepage]
|
||||
other = "Go to homepage"
|
||||
|
||||
[Edit-this-page]
|
||||
other = "Edit page"
|
||||
@@ -1,35 +0,0 @@
|
||||
[create-header-md]
|
||||
other = "Créez un fichier _header.md pour personaliser cet encart"
|
||||
|
||||
[Search-placeholder]
|
||||
other = "Rechercher..."
|
||||
|
||||
[Clear-History]
|
||||
other = "Supprimer historique"
|
||||
|
||||
[Page]
|
||||
other = "Page"
|
||||
|
||||
[Next-Pages]
|
||||
other = "Pages suivantes"
|
||||
|
||||
[Previous-Pages]
|
||||
other = "Pages précédentes"
|
||||
|
||||
[pagination-on]
|
||||
other = "sur"
|
||||
|
||||
[Attachments-label]
|
||||
other = "Documents attachés"
|
||||
|
||||
[title-404]
|
||||
other = "Erreur"
|
||||
|
||||
[message-404]
|
||||
other = "Woops. Looks like this page doesn't exist."
|
||||
|
||||
[Go-to-homepage]
|
||||
other = "Vers la page d'accueil"
|
||||
|
||||
[Edit-this-page]
|
||||
other = "Modifier"
|
||||
@@ -1,35 +0,0 @@
|
||||
[create-header-md]
|
||||
other = "Opprett en _header.md for å tilpasse denne"
|
||||
|
||||
[Search-placeholder]
|
||||
other = "Søk..."
|
||||
|
||||
[Clear-History]
|
||||
other = "Fjern historikk"
|
||||
|
||||
[Page]
|
||||
other = "Side"
|
||||
|
||||
[Next-Pages]
|
||||
other = "Neste"
|
||||
|
||||
[Previous-Pages]
|
||||
other = "Forrige"
|
||||
|
||||
[pagination-on]
|
||||
other = "av"
|
||||
|
||||
[Attachments-label]
|
||||
other = "Vedlegg"
|
||||
|
||||
[title-404]
|
||||
other = "Feil"
|
||||
|
||||
[message-404]
|
||||
other = "Ups... Ser ikke ut som denne siden eksisterer."
|
||||
|
||||
[Go-to-homepage]
|
||||
other = "Gå til hovedsiden"
|
||||
|
||||
[Edit-this-page]
|
||||
other = "Editer"
|
||||
|
Before Width: | Height: | Size: 345 KiB |
|
Before Width: | Height: | Size: 137 KiB |
@@ -1,53 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="js csstransforms3d">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8"> {{ partial "meta.html" . }}
|
||||
<link rel="shortcut icon" href="{{"images/favicon.png" | relURL}}" type="image/x-icon" />
|
||||
{{ .Scratch.Add "title" "" }}{{ if eq .Site.Data.titles .Title }}{{ .Scratch.Set "title" (index .Site.Data.titles .Title).title }}{{ else }}{{ .Scratch.Set "title" .Title}}{{end}}
|
||||
<title>{{ .Scratch.Get "title" }}</title>
|
||||
<link href="{{"css/nucleus.css" | relURL}}" rel="stylesheet">
|
||||
<link href="{{"css/font-awesome.min.css" | relURL}}" rel="stylesheet">
|
||||
<link href="{{"css/hybrid.css" | relURL}}" rel="stylesheet">
|
||||
<link href="{{"css/featherlight.min.css" | relURL}}" rel="stylesheet">
|
||||
<link href="{{"css/theme.css" | relURL}}" rel="stylesheet">
|
||||
<style type="text/css">
|
||||
:root #header + #content > #left > #rlblock_left {
|
||||
display: none !important;
|
||||
}
|
||||
|
||||
p,
|
||||
li,
|
||||
ul {
|
||||
text-align: center
|
||||
}
|
||||
|
||||
ul {
|
||||
list-style-type: none;
|
||||
}
|
||||
</style>
|
||||
{{ partial "custom-head.html" . }}
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<body class="" data-url="/">
|
||||
|
||||
<section id="body" style="margin-left:0px;">
|
||||
<div id="overlay"></div>
|
||||
<div id="chapter">
|
||||
<div id="body-inner">
|
||||
<h1>{{T "title-404"}}</h1>
|
||||
<p>
|
||||
</p>
|
||||
<p>{{T "message-404"}}</p>
|
||||
<p></p>
|
||||
<p><a href="{{.Site.BaseURL}}">{{T "Go-to-homepage"}}</a></p>
|
||||
<p><img src="{{"images/gopher-404.jpg" | relURL}}" style="width:50%"></img></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
@@ -1,25 +0,0 @@
|
||||
<article class="post {{ .Section }}">
|
||||
<header class="post-header">
|
||||
<h2 class="post-title"><a href="{{ .RelPermalink }}">{{ .Title }}</a></h2>
|
||||
</header>
|
||||
<section class="post-excerpt">
|
||||
<p>{{ .Summary }} <a class="read-more" href="{{.RelPermalink}}">»</a></p>
|
||||
</section>
|
||||
<footer class=" footline" >
|
||||
|
||||
{{with .Params.LastModifierDisplayName}}
|
||||
<i class='fa fa-user'></i> <a href="mailto:{{ $.Params.LastModifierEmail }}">{{ . }}</a> {{with $.Date}} <i class='fa fa-calendar'></i> {{ .Format "02/01/2006" }}{{end}}
|
||||
{{end}}
|
||||
|
||||
|
||||
{{if .Params.tags }}
|
||||
{{ range $index, $tag := .Params.tags }}
|
||||
<a class="label label-default" href="{{$.Site.BaseURL}}tags/{{ $tag | urlize }}/">{{ $tag }}</a>
|
||||
{{ end }}
|
||||
{{end}}
|
||||
|
||||
</footer>
|
||||
</article>
|
||||
|
||||
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
{{ partial "header.html" . }}
|
||||
<span id="sidebar-toggle-span">
|
||||
<a href="#" id="sidebar-toggle" data-sidebar-toggle=""><i class="fa fa-bars"></i> navigation</a>
|
||||
</span>
|
||||
|
||||
{{if .Site.Home.Content }}
|
||||
{{.Site.Home.Content}}
|
||||
{{else}}
|
||||
{{if eq .Site.Language.Lang "fr"}}
|
||||
<h1>Personaliser la page d'accueil</h1>
|
||||
<p>
|
||||
Le site fonctionne. Ne pas oublier de personaliser cette page avec votre propre contenu. 2 façons de faire :
|
||||
</p>
|
||||
<ul>
|
||||
<li><b>1. </b> Créer un fichier _index.md dans le dossier content</li>
|
||||
<li><b>2. </b> Configurer le serveur http pour rediriger automatiquement la homepage vers la page de votre choix dans le site</li>
|
||||
</ul>
|
||||
{{else}}
|
||||
<h1>Customize your own home page</h1>
|
||||
<p>
|
||||
The site is working. Don't forget to customize this homepage with your own. You typically have 2 choices :
|
||||
</p>
|
||||
<ul>
|
||||
<li><b>1. </b> Create an _index.md document in the content folder</li>
|
||||
<li><b>2. </b> Configure your server to automatically redirect this home page to one of your documentation pages</li>
|
||||
</ul>
|
||||
{{end}}
|
||||
<p><i class="fa fa-heart fa-4x"></i></p>
|
||||
{{ end }}
|
||||
{{ partial "footer.html" . }}
|
||||
@@ -1 +0,0 @@
|
||||
<!-- Partial intended to be overwritten for content footers like commenting systems -->
|
||||
@@ -1 +0,0 @@
|
||||
<!-- Partial intended to be overwritten to add javacript -->
|
||||
@@ -1 +0,0 @@
|
||||
<!-- Partial intended to be overwritten to add CSS -->
|
||||
@@ -1,88 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="{{ .Page.Language | default "en" }}" class="js csstransforms3d">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
|
||||
{{ .Hugo.Generator }}
|
||||
{{ partial "meta.html" . }}
|
||||
<title>{{ .Title }} :: {{ .Site.Title }}</title>
|
||||
<link rel="shortcut icon" href="{{"images/favicon.png" | relURL}}" type="image/x-icon" />
|
||||
<link href="{{"css/nucleus.css" | relURL}}" rel="stylesheet">
|
||||
<link href="{{"css/font-awesome.min.css" | relURL}}" rel="stylesheet">
|
||||
<link href="{{"css/hybrid.css" | relURL}}" rel="stylesheet">
|
||||
<link href="{{"css/featherlight.min.css" | relURL}}" rel="stylesheet">
|
||||
<link href="{{"css/horsey.css" | relURL}}" rel="stylesheet">
|
||||
{{with .Site.Params.themeStyle}}
|
||||
<link href="{{(printf "css/%s.css" .) | relURL}}" rel="stylesheet">
|
||||
{{else}}
|
||||
<link href="{{"css/theme.css" | relURL}}" rel="stylesheet">
|
||||
{{end}}
|
||||
{{with .Site.Params.themeVariant}}
|
||||
<link href="{{(printf "css/theme-%s.css" .) | relURL}}" rel="stylesheet">
|
||||
{{end}}
|
||||
<link rel="stylesheet" href="{{"css/bootstrap.min.css" | relURL}}">
|
||||
<script src="{{"js/jquery-2.x.min.js" | relURL}}"></script>
|
||||
<style type="text/css">
|
||||
:root #header + #content > #left > #rlblock_left {
|
||||
display:none !important;
|
||||
}
|
||||
</style>
|
||||
|
||||
|
||||
|
||||
{{ partial "custom-head.html" . }}
|
||||
</head>
|
||||
<body class="" data-url="{{ .RelPermalink }}">
|
||||
{{ partial "menu.html" . }}
|
||||
<section id="body">
|
||||
<div id="overlay"></div>
|
||||
<div class="padding highlightable">
|
||||
{{if not .IsHome}}
|
||||
<div id="top-bar">
|
||||
{{ if and (or .IsPage .IsSection) .Site.Params.editURL }}
|
||||
{{ $File := .File }}
|
||||
{{ $Site := .Site }}
|
||||
{{with $File.Path }}
|
||||
<div id="top-github-link">
|
||||
<a class="github-link" href="{{ $Site.Params.editURL }}{{ replace $File.Dir "\\" "/" }}{{ $File.LogicalName }}" target="blank">
|
||||
<i class="fa fa-code-fork"></i>
|
||||
{{T "Edit-this-page"}}
|
||||
</a>
|
||||
</div>
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
|
||||
<div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
|
||||
<span id="sidebar-toggle-span">
|
||||
<a href="#" id="sidebar-toggle" data-sidebar-toggle="">
|
||||
<i class="fa fa-bars"></i>
|
||||
</a>
|
||||
</span>
|
||||
<span id="toc-menu"><i class="fa fa-list-alt"></i></span>
|
||||
<span class="links">
|
||||
{{ template "breadcrumb" dict "page" . "value" .Title }}
|
||||
</span>
|
||||
</div>
|
||||
{{ partial "toc.html" . }}
|
||||
</div>
|
||||
{{end}}
|
||||
{{if .Params.tags }}
|
||||
<div id="tags">
|
||||
{{ range $index, $tag := .Params.tags }}
|
||||
<a class="label label-default" href="{{$.Site.BaseURL}}/tags/{{ $tag | urlize }}">{{ $tag }}</a>
|
||||
{{ end }}
|
||||
</div>
|
||||
{{end}}
|
||||
<div id="body-inner">
|
||||
{{if not .IsHome}}
|
||||
<h1>{{.Title}}</h1>
|
||||
{{end}}
|
||||
|
||||
{{define "breadcrumb"}}
|
||||
{{ if .page.Parent}}
|
||||
{{$value := (printf "<a href='%s'>%s</a> > %s" .page.Parent.URL .page.Parent.Title .value)}}
|
||||
{{ template "breadcrumb" dict "page" .page.Parent "value" $value }}
|
||||
{{else}}
|
||||
{{.value|safeHTML}}
|
||||
{{end}}
|
||||
{{end}}
|
||||
@@ -1,10 +0,0 @@
|
||||
{{ range where .Site.Pages "Source.BaseFileName" "_header" }}
|
||||
{{ .Content }}
|
||||
{{else}}
|
||||
<span style="font-size:smaller">
|
||||
<a id="logo" href="{{.Site.BaseURL}}">
|
||||
<span class="fa fa-gears" style="font-size:large"></span>
|
||||
</a>
|
||||
{{ T "create-header-md" }}
|
||||
</small>
|
||||
{{end}}
|
||||
@@ -1,126 +0,0 @@
|
||||
<nav id="sidebar" class="{{if $.Site.Params.showVisitedLinks }}showVisitedLinks{{end}}">
|
||||
|
||||
|
||||
|
||||
{{ $currentNode := . }}
|
||||
{{ $showvisitedlinks := .Site.Params.showVisitedLinks }}
|
||||
<div class="highlightable">
|
||||
<div id="header-wrapper">
|
||||
<div id="header">
|
||||
{{ partial "logo.html" . }}
|
||||
</div>
|
||||
{{if not .Site.Params.noSearch}}
|
||||
{{ partial "search.html" . }}
|
||||
{{end}}
|
||||
</div>
|
||||
|
||||
|
||||
<ul class="topics">
|
||||
{{if not .Site.Params.noHomeIcon}}
|
||||
<li data-nav-id="{{"/" | relURL}}" class="dd-item">
|
||||
<a href="{{"/" | relURL}}"><i class="fa fa-fw fa-home"></i></a>
|
||||
</li>
|
||||
{{end}}
|
||||
|
||||
{{if eq .Site.Params.ordersectionsby "title"}}
|
||||
{{range .Site.Home.Sections.ByTitle}}
|
||||
{{ template "section-tree-nav" dict "sect" . "currentnode" $currentNode "showvisitedlinks" $showvisitedlinks}}
|
||||
{{end}}
|
||||
{{else}}
|
||||
{{range .Site.Home.Sections.ByWeight}}
|
||||
{{ template "section-tree-nav" dict "sect" . "currentnode" $currentNode "showvisitedlinks" $showvisitedlinks}}
|
||||
{{end}}
|
||||
{{end}}
|
||||
|
||||
{{with .Site.Menus.shortcuts}}
|
||||
<section id="shortcuts">
|
||||
{{ range sort . "Weight"}}
|
||||
<li class="" role="">
|
||||
{{.Pre}}
|
||||
<a href="{{.URL}}">{{safeHTML .Name}}</a>
|
||||
{{.Post}}
|
||||
</li>
|
||||
{{end}}
|
||||
</section>
|
||||
|
||||
{{ if $.Site.Params.showVisitedLinks}}
|
||||
<a class="" href="#" data-clear-history-toggle=""><i class="fa fa-history"></i> {{T "Clear-History"}}</a>
|
||||
{{ end }}
|
||||
|
||||
{{end}}
|
||||
</ul>
|
||||
|
||||
|
||||
<section id="footer">
|
||||
{{ partial "menu-footer.html" . }}
|
||||
</section>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<!-- templates -->
|
||||
{{ define "section-tree-nav" }}
|
||||
{{ $showvisitedlinks := .showvisitedlinks }}
|
||||
{{ $currentNode := .currentnode }}
|
||||
{{with .sect}}
|
||||
{{if .IsSection}}
|
||||
{{safeHTML .Params.head}}
|
||||
<li data-nav-id="{{.URL}}" class="dd-item
|
||||
{{if .IsAncestor $currentNode }}parent{{end}}
|
||||
{{if eq .UniqueID $currentNode.UniqueID}}active{{end}}
|
||||
{{if .Params.alwaysopen}}parent{{end}}
|
||||
">
|
||||
<a href="{{ .RelPermalink}}">
|
||||
<span>{{safeHTML .Params.Pre}}{{.Title}}{{safeHTML .Params.Post}}</span>
|
||||
|
||||
{{ $numberOfPages := (add (len .Pages) (len .Sections)) }}
|
||||
{{ if ne $numberOfPages 0 }}
|
||||
|
||||
{{if or (.IsAncestor $currentNode) (.Params.alwaysopen) }}
|
||||
<i class="fa fa-angle-down fa-lg category-icon"></i>
|
||||
{{else}}
|
||||
<i class="fa fa-angle-right fa-lg category-icon"></i>
|
||||
{{end}}
|
||||
|
||||
{{ end }}
|
||||
|
||||
{{ if $showvisitedlinks}}<i style="color:grey" class="fa fa-circle-thin read-icon"></i>{{end}}
|
||||
</a>
|
||||
{{ if ne $numberOfPages 0 }}
|
||||
<ul>
|
||||
{{ .Scratch.Set "pages" .Pages }}
|
||||
{{ if .Sections}}
|
||||
{{ .Scratch.Set "pages" (.Pages | union .Sections) }}
|
||||
{{end}}
|
||||
{{ $pages := (.Scratch.Get "pages") }}
|
||||
|
||||
{{if eq .Site.Params.ordersectionsby "title"}}
|
||||
{{ range $pages.ByTitle }}
|
||||
{{ if and .Params.hidden (not $.showhidden) }}
|
||||
{{else}}
|
||||
{{ template "section-tree-nav" dict "sect" . "currentnode" $currentNode "showvisitedlinks" $showvisitedlinks }}
|
||||
{{end}}
|
||||
{{ end }}
|
||||
{{else}}
|
||||
{{ range $pages.ByWeight }}
|
||||
{{ if and .Params.hidden (not $.showhidden) }}
|
||||
{{else}}
|
||||
{{ template "section-tree-nav" dict "sect" . "currentnode" $currentNode "showvisitedlinks" $showvisitedlinks }}
|
||||
{{end}}
|
||||
{{ end }}
|
||||
{{end}}
|
||||
</ul>
|
||||
{{ end }}
|
||||
</li>
|
||||
{{else}}
|
||||
{{ if not .Params.Hidden }}
|
||||
<li data-nav-id="{{.URL}}" class="dd-item
|
||||
{{if eq .UniqueID $currentNode.UniqueID}}active{{end}}
|
||||
">
|
||||
<a href="{{ .RelPermalink}}">
|
||||
<span>{{safeHTML .Params.Pre}}{{.Title}}{{safeHTML .Params.Post}}</span>
|
||||
{{ if $showvisitedlinks}}<i style="color:grey" class="fa fa-circle-thin read-icon"></i>{{end}}
|
||||
</a></li>
|
||||
{{ end }}
|
||||
{{end}}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
@@ -1,9 +0,0 @@
|
||||
<nav class="pagination" role="navigation">
|
||||
{{if .HasPrev}}
|
||||
<a class="newer-posts" href="{{ .Prev.URL }}">← {{T "Previous-Pages"}}</a>
|
||||
{{end}}
|
||||
<span class="page-number">{{T "Page"}} {{ .PageNumber }} {{T "pagination-on"}} {{.TotalPages}}</span>
|
||||
{{if .HasNext}}
|
||||
<a class="older-posts" href="{{ .Next.URL }}">{{T "Next-Pages"}} →</a>
|
||||
{{end}}
|
||||
</nav>
|
||||
@@ -1,13 +0,0 @@
|
||||
<script src="{{"js/clipboard.min.js" | relURL}}"></script>
|
||||
<script src="{{"js/featherlight.min.js" | relURL}}"></script>
|
||||
<script src="{{"js/html5shiv-printshiv.min.js" | relURL}}"></script>
|
||||
<script src="{{"js/highlight.pack.js" | relURL}}"></script>
|
||||
<!--<script>hljs.initHighlightingOnLoad();</script>-->
|
||||
<script src="{{"js/modernizr.custom.71422.js" | relURL}}"></script>
|
||||
<script src="{{"js/learn.js" | relURL}}"></script>
|
||||
<script src="{{"js/hugo-learn.js" | relURL}}"></script>
|
||||
|
||||
|
||||
<link href="{{"mermaid/mermaid.css" | relURL}}" type="text/css" rel="stylesheet"/>
|
||||
<script src="{{"mermaid/mermaid.js" | relURL}}"></script>
|
||||
<script>mermaid.initialize({startOnLoad:true});</script>
|
||||
@@ -1,11 +0,0 @@
|
||||
<div class="searchbox">
|
||||
<label for="search-by"><i class="fa fa-search"></i></label>
|
||||
<input data-search-input id="search-by" type="text" placeholder="{{T "Search-placeholder"}}">
|
||||
<span data-search-clear=""><i class="fa fa-close"></i></span>
|
||||
</div>
|
||||
<script type="text/javascript" src="{{"js/lunr.min.js" | relURL}}"></script>
|
||||
<script type="text/javascript" src="{{"js/horsey.js" | relURL}}"></script>
|
||||
<script type="text/javascript">
|
||||
var baseurl = "{{.Site.BaseURL}}";
|
||||
</script>
|
||||
<script type="text/javascript" src="{{"js/search.js" | relURL}}"></script>
|
||||
@@ -1,6 +0,0 @@
|
||||
<div class="alert {{ if .IsNamedParams }}
|
||||
{{with .Get "theme" }}alert-{{.}}{{else}}alert-info{{end}}"
|
||||
{{else}}
|
||||
{{with .Get 0 }}alert-{{.}}{{else}}alert-info{{end}}"
|
||||
{{end}}
|
||||
role="alert">{{.Inner}}</div>
|
||||
@@ -1 +0,0 @@
|
||||
<anchor id="anchor-{{.Get "default"}}">{{.Inner}}</anchor>
|
||||
@@ -1 +0,0 @@
|
||||
<a href="#anchor-{{.Get "anchor"}}" title="" >{{.Inner}}</a>
|
||||
@@ -1,5 +0,0 @@
|
||||
{{range $i, $att := .Page.Params.attachments }}
|
||||
{{if eq $att.filename ($.Get "filename")}}
|
||||
<a class="{{$att.iconclass}}" href="{{$.Site.BaseURL}}{{$.Page.Params.id}}/{{$att.filename}}" title="Dernière modification le {{$att.lastmodifieddate}}" >{{$.Inner}}</a> ({{$att.nicefilesize}})
|
||||
{{end}}
|
||||
{{end}}
|
||||
@@ -1,6 +0,0 @@
|
||||
<!-- Boutton -->
|
||||
{{ with .Get "align" }}<center>{{end}}
|
||||
<button class="btn {{with .Get "theme"}}btn-{{.}}{{else}}btn-primary{{end}}" type="button" {{ with .Get "href" }} onclick="location.href='{{.}}'"{{end}} >{{.Inner}}</button>
|
||||
{{ with .Get "align" }}</center>{{end}}
|
||||
|
||||
<!-- Boutton -->
|
||||
@@ -1 +0,0 @@
|
||||
<pre><code>{{.Inner}}</code></pre>
|
||||
@@ -1,29 +0,0 @@
|
||||
{{ $name := .Get "name"}}
|
||||
|
||||
{{ if eq "smile" $name}}
|
||||
😀
|
||||
{{ else if eq "sad" $name}}
|
||||
🙁
|
||||
{{ else if eq "cheeky" $name}}
|
||||
😛
|
||||
{{ else if eq "laugh" $name}}
|
||||
😃
|
||||
{{ else if eq "wink" $name}}
|
||||
😉
|
||||
{{ else if eq "thumbs-up" $name}}
|
||||
<span class="glyphicon glyphicon-thumbs-up" aria-hidden="true"></span>
|
||||
{{ else if eq "thumbs-down" $name}}
|
||||
<span class="glyphicon glyphicon-thumbs-down" aria-hidden="true"></span>
|
||||
{{ else if eq "information" $name}}
|
||||
<span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
|
||||
{{ else if eq "tick" $name}}
|
||||
<span class="glyphicon glyphicon-ok-circle" aria-hidden="true"></span>
|
||||
{{ else if eq "cross" $name}}
|
||||
<span class="glyphicon glyphicon-remove-circle" aria-hidden="true"></span>
|
||||
{{ else if eq "warning" $name}}
|
||||
<span class="glyphicon glyphicon-warning-sign" aria-hidden="true"></span>
|
||||
{{else}}
|
||||
( Emoticon: {{$name}} )
|
||||
{{end}}
|
||||
|
||||
{{.Inner}}
|
||||
@@ -1,14 +0,0 @@
|
||||
{{ $excerpt := findRE "(?ms){{%\\s*excerpt[^%]*%}}(.|\n)*?{{%\\s*/excerpt\\s*%}}" ( readFile (printf "./content/%s" (.Get "filename")) ) }}
|
||||
{{ range $excerpt }}
|
||||
{{if ($.Get "panel")}}
|
||||
<div class="panel panel-default">
|
||||
<div class="panel-heading">{{$.Get "panel"}}</div>
|
||||
<div class="panel-body">
|
||||
{{ (replaceRE "(?ms){{%\\s*excerpt[^%]*%}}(.*){{%\\s*/excerpt\\s*%}}" "$1" .) | safeHTML | markdownify }}
|
||||
</div>
|
||||
</div>
|
||||
{{else}}
|
||||
{{ (replaceRE "(?ms){{%\\s*excerpt[^%]*%}}(.*){{%\\s*/excerpt\\s*%}}" "$1" .) | safeHTML | markdownify }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
{{.Inner}}
|
||||
@@ -1,7 +0,0 @@
|
||||
{{with .Get "hidden"}}
|
||||
{{if eq . "false"}}
|
||||
{{$.Inner}}
|
||||
{{end}}
|
||||
{{else}}
|
||||
{{.Inner}}
|
||||
{{end}}
|
||||