Sha256: 6ad5bf5f96d17f53ab18ec9450538a690665a8a7f08a604c1f032667802bdca5

Contents?: true

Size: 1.37 KB

Versions: 19

Compression:

Stored size: 1.37 KB

Contents

---
title: Helpers
---

Kubes provides some helper methods to help write Kubernetes YAML files.  Here's a list of the helper methods. These are available whether you write your resources in YAML or DSL.

Helper | Description
--- | ---
decode64 | Base64 decode a string.
docker_image | Method refers to the latest Docker image built by Kubes. This spares you from having to update the image manually in the deployment resource. Note, this can be overridden with the `--image` cli option or the `Kubes.config.image` setting. See: [Docker Image]({% link _docs/intro/docker-image.md %})
dockerfile_port	| Exposed port extracted from the Dockerfile of the project.
encode64 | Base64 encode a string. Also available as `base64` method.
extra | The `KUBES_EXTRA` value.
with_extra | Appends the `KUBES_EXTRA` value to a string if it's set. It's covered in the [Extra Env Docs]({% link _docs/extra-env.md %}).

Here's also the source code with most of the helpers: [helpers.rb](https://github.com/boltops-tools/kubes/blob/master/lib/kubes/compiler/shared/helpers.rb).

## DSL Specific Methods

Each DSL resource has it's own specific methods. Refer to the [DSL Docs]({% link _docs/dsl.md %}) for their methods.

## Provider Helpers

There are also provider-specific helpers:

* [AWS Helpers]({% link _docs/helpers/aws.md %})
* [Google Helpers]({% link _docs/helpers/google.md %})

{% include helpers/generator.md %}

Version data entries

19 entries across 19 versions & 1 rubygems

Version Path
kubes-0.8.2 docs/_docs/helpers.md
kubes-0.8.1 docs/_docs/helpers.md
kubes-0.8.0 docs/_docs/helpers.md
kubes-0.7.10 docs/_docs/helpers.md
kubes-0.7.9 docs/_docs/helpers.md
kubes-0.7.8 docs/_docs/helpers.md
kubes-0.7.7 docs/_docs/helpers.md
kubes-0.7.6 docs/_docs/helpers.md
kubes-0.7.5 docs/_docs/helpers.md
kubes-0.7.4 docs/_docs/helpers.md
kubes-0.7.3 docs/_docs/helpers.md
kubes-0.7.2 docs/_docs/helpers.md
kubes-0.7.1 docs/_docs/helpers.md
kubes-0.7.0 docs/_docs/helpers.md
kubes-0.6.8 docs/_docs/helpers.md
kubes-0.6.7 docs/_docs/helpers.md
kubes-0.6.6 docs/_docs/helpers.md
kubes-0.6.5 docs/_docs/helpers.md
kubes-0.6.4 docs/_docs/helpers.md