Skip to content

Commit

Permalink
added drillster docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bradrydzewski committed Dec 15, 2016
1 parent 8d10089 commit 43dc03f
Show file tree
Hide file tree
Showing 58 changed files with 5,053 additions and 183 deletions.
7 changes: 3 additions & 4 deletions .drone.yml
Expand Up @@ -2,19 +2,18 @@ workspace:
path: src

pipeline:
build:
generate:
image: golang:1.6
commands:
- go run scripts/plugin-gen-all.go
- go run scripts/plugin-fallback-all.go
- go run scripts/gen-language-content.go

build:
image: webhippie/hugo:latest
commands:
- git clone https://github.com/drone/drone-hugo-theme.git themes/drone-hugo-theme
- hugo

upload:
publish:
image: plugins/s3-sync:1.1
access: public-read
region: us-east-1
Expand Down
5 changes: 1 addition & 4 deletions .gitignore
@@ -1,6 +1,3 @@
public/*
themes/*
content/*
!content/.gitkeep
static/logos/*
!static/logos/.gitkeep
content/**.gen.*
7 changes: 0 additions & 7 deletions PLUGINS

This file was deleted.

60 changes: 60 additions & 0 deletions archetypes/default.md
@@ -0,0 +1,60 @@
---
date: 2016-01-01T00:00:00+00:00
title: ""
author: ""
tags: [ "", "" ]
repo: ""
logo: ""
image: ""
url: ""
---

The PLUGIN_NAME can be used to DO_SOMETHING. The below pipeline configuration demonstrates simple usage:

```yaml
pipeline:
replace_me:
image: replace_me
param1: replace_me
```

Example configuration using param2:

```diff
pipeline:
replace_me:
image: replace/me
+ param2: replaceme
```

Example configuration using param3:

```diff
pipeline:
replace_me:
image: replace/me
param2: replace_me
+ param3: replace_me
```

# Secret Reference

FOO_SECRET1
: description of secret1

FOO_SECRET1
: description of secret2

FOO_SECRET3
: description of secret3

# Parameter Reference

param1
: description of param1 in yaml

param2
: description of param2 in yaml

param3
: description of param3 in yaml
6 changes: 5 additions & 1 deletion config.yaml
Expand Up @@ -216,6 +216,10 @@ languages:
ko:
weight: 9
languageName: 한국어
heading: 플러그인
tagline: >
Browse our registry of community plugins to customize
your continuous delivery pipeline.
menu:
main:
- identifier: documentation
Expand All @@ -236,7 +240,7 @@ languages:
url: /ko/

ru:
weight: 9
weight: 10
languageName: pусский
menu:
main:
Expand Down
Empty file removed content/.gitkeep
Empty file.
107 changes: 107 additions & 0 deletions content/drillster/drone-volume-cache/drone-volume-cache.md
@@ -0,0 +1,107 @@
---
author: "drillster"
date: 2016-12-15T15:57:35-05:00
image: "drillster/drone-volume-cache"
repo: "drillster/drone-volume-cache"
tags:
- "cache"
title: Volume Cache
url: "drillster/drone-volume-cache"
---

{{% alert error %}}
This plugin requires Volume configuration. This means your repository Trusted flag must be enabled. This should not be enabled in untrusted environments.
{{% /alert %}}

The volume cache plugin can be used to preserve files and directories between builds. The below pipeline configuration demonstrates simple usage.

```yaml
pipeline:
restore-cache:
image: drillster/drone-volume-cache
restore: true
mount:
- ./node_modules
volumes:
- /tmp/cache:/cache

build:
image: node
commands:
- npm install

rebuild-cache:
image: drillster/drone-volume-cache
rebuild: true
mount:
- ./node_modules
volumes:
- /tmp/cache:/cache
```

The mount attribute defines a list of files or directories that should be cached and restored.

{{% alert warn %}}
The cached files or directories must be located in your build workspace. It is not possible to cache files outside of your build workspace.
{{% /alert %}}

```diff
pipeline:
restore-cache:
image: drillster/drone-volume-cache
restore: true
+ mount:
+ - node_modules
volumes:
- /tmp/cache:/cache
```

The `rebuild` flag instructs the plugin to copy files from the build environment to the host machine. This should be declared at the end of your pipeline.

```diff
pipeline:
rebuild-cache:
image: drillster/drone-volume-cache
+ rebuild: true
mount:
- node_modules
volumes:
- /tmp/cache:/cache
```

The `restore` flag instructs the plugin to copy files from the host machine to your build environment. This should be declared at the beginning of your pipeline, before your build steps.

```diff
pipeline:
restore-cache:
image: drillster/drone-volume-cache
+ restore: true
mount:
- node_modules
volumes:
- /tmp/cache:/cache
```

The volume attribute defines the path on the host machine where the cache is stored. The host machine volume must be mounted into container path `/cache`.

```diff
pipeline:
restore-cache:
image: drillster/drone-volume-cache
restore: true
mount:
- node_modules
+ volumes:
+ - /tmp/cache:/cache
```

# Parameter Reference

restore
: instruct plugin to restore cache, can be true or false

rebuild
: instruct plugin to rebuild cache, can be true or false

mount
: list of folders to cache
171 changes: 171 additions & 0 deletions content/drone-plugins/drone-docker/drone-docker.gen.es.md
@@ -0,0 +1,171 @@
---
date: 2016-01-01T00:00:00+00:00
title: Docker
author: drone-plugins
tags: [ publish, docker ]
repo: drone-plugins/drone-docker
logo: docker.svg
image: plugins/drone
url: drone-plugins/drone-docker
---

The Docker plugin can be used to build and publish images to the Docker registry. The following pipeline configuration uses the Docker plugin to build and publish Docker images:

```yaml
pipeline:
docker:
image: plugins/docker
username: kevinbacon
password: pa55word
email: kevin.bacon@mail.com
repo: foo/bar
tags: latest
```

Example configuration using multiple tags:

```diff
pipeline:
docker:
image: plugins/docker
repo: foo/bar
- tags: latest
+ tags:
+ - latest
+ - 1.0.1
+ - 1.0
```

Example configuration using build arguments:

```diff
publish:
docker:
image: plugins/docker
repo: foo/bar
+ build_args:
+ - HTTP_PROXY=http://yourproxy.com
```

Example configuration using alternate Dockerfile:

```diff
publish:
docker:
image: plugins/docker
repo: foo/bar
- dockerfile: Dockerfile
+ dockerfile: path/to/Dockerfile
```

Example configuration using a custom registry:

```diff
pipeline:
docker:
image: plugins/docker
- repo: foo/bar
+ repo: index.company.com/foo/bar
+ registry: index.company.com
```

Example configuration using inline credentials:

```diff
pipeline:
docker:
image: plugins/docker
+ username: kevinbacon
+ password: pa55word
repo: foo/bar
```

# Secrets

The Docker plugin supports reading credentials from the Drone secret store. This is strongly recommended instead of storing credentials in the pipeline configuration in plain text.

```diff
pipeline:
docker:
image: plugins/docker
- username: kevinbacon
- password: pa55word
repo: foo/bar
```

Use the command line utility to add secrets to the store:

```nohighlight
drone secret add --image=plugins/docker \
octocat/hello-world DOCKER_USERNAME kevinbacon
drone secret add --image=plugins/docker \
octocat/hello-world DOCKER_PASSWORD pa55word
```

Don't forget to sign the Yaml after making changes:

```nohighlight
drone sign octocat/hello-world
```

# Secret Reference

DOCKER_USERNAME
: docker registry username

DOCKER_PASSWORD
: docker registry password

DOCKER_EMAIL
: docker registry email

# Parameter Reference

registry
: authenticates to this registry

username
: authenticates with this username

password
: authenticates with this password

email
: authenticates with this email

repo
: repository name for the image

tags
: repository tag for the image

dockerfile
: dockerfile to be used, defaults to Dockerfile

auth
: auth token for the registry

context
: the context path to use, defaults to root of the git repo

force_tag=false
: replace existing matched image tags

insecure=false
: enable insecure communication to this registry

mirror
: use a mirror registry instead of pulling images directly from the central Hub

bip=false
: use for pass bridge ip

dns
: set custom dns servers for the container

storage_driver
: supports `aufs`, `overlay` or `vfs` drivers

build_args
: custom arguments passed to docker build

0 comments on commit 43dc03f

Please sign in to comment.