Commit graph

111 commits

Author SHA1 Message Date
Matt Butcher
d7e56133d6 Merge pull request #1386 from slack/doc-rollback
doc(rollback): add docs for pre/post rollback hooks
2016-10-18 10:31:44 -06:00
Matt Butcher
63840043f1 Merge pull request #1373 from technosophos/docs/provenance-authority
docs(provenance): describe signature authority
2016-10-18 10:31:24 -06:00
Jason Hansen
07564588ed
doc(rollback): add docs for pre/post rollback hooks 2016-10-17 17:28:06 -07:00
Matt Butcher
627c59d148 docs(*): refresh docs
This refreshes docs, as discussed in #719, and adds a few new sections
to the docs.

Closes #719
2016-10-17 12:15:10 -06:00
Matt Butcher
3ec188610b Merge pull request #1379 from ammeon/docs-fix
docs(helm): Fix broken link to glide project
2016-10-17 11:18:41 -06:00
Michelle Noorali
8b551d474c chore(docs): fix nginx example templates 2016-10-17 11:42:47 -04:00
Nic Roland
6eb3dd1d6c docs(helm): Fix broken link to glide project 2016-10-17 13:33:02 +01:00
Matt Butcher
04e94c81b8 docs(provenance): describe signature authority 2016-10-14 11:25:07 -06:00
Matt Butcher
9c3f883ec3 Merge pull request #1355 from technosophos/docs/1348-missing-created-timestamp
docs(chart_repositories): document correct index example
2016-10-13 12:14:14 -06:00
Matt Butcher
491dc32552 docs(chart_repositories): document correct index example
The previous index.yaml example was missing a few fields, notably the
'created' timestamp.

Closes #1348
2016-10-13 10:21:23 -06:00
Adam Reese
f5c07ea0cf docs(developers): require glide 0.12.0
ref: #1310
2016-10-12 16:55:27 -07:00
Matt Butcher
e78cce27ff Merge pull request #1350 from christensenemc/patch-1
Fixed broken link from "chart.md" to "charts.md"
2016-10-12 16:19:43 -06:00
Matt Butcher
a747289b2f Merge pull request #1344 from technosophos/docs/1343-helm-repo-index-url
docs(repo): update repo index docs to show new flags
2016-10-12 13:57:09 -06:00
Erik Christensen
d379eda785 Fixed broken link from "chart.md" to "charts.md" 2016-10-12 15:07:26 -04:00
Matt Butcher
2388e71528 fix(helm): ignore dotfiles in charts/ directories
This causes 'helm dep [up|install]' to ignore files in charts/ that
start with either a dot or an underscore. It also changes the
chartloader to ignore those files.

Also, if a 'helm dep up' does not find a charts/ directory, it creates
one.

Closes #1342
2016-10-11 18:59:45 -06:00
Matt Butcher
11d4a67a80 docs(repo): update repo index docs to show new flags
This adds the `--url` flag to examples.

Closes #1343
2016-10-11 17:27:10 -06:00
Ken Wronkiewicz
3c27a071ae docs(install): Add reference to hg in install docs
Also, hg is required.
2016-10-09 11:57:08 -07:00
Ken Wronkiewicz
f333bc37a0 docs(install): Add reference to glide in install docs
The user needs to get all of the way down to developers docs to
realize they need glide, but if you follow a user who doesn't
necessarily want to develop but wants to build from source, you'd
follow this path:
README -> Quick Start -> Releases -> . o O (Source doesn't work)
 -> Install
And then you'd realize that you need Glide.

This one-liner patch fixes that. :)
2016-10-09 11:38:52 -07:00
Matt Butcher
990dc37fc1 Merge pull request #1296 from javiercr/patch-1
Fix typo in chart docs
2016-10-07 17:10:41 -06:00
Javier Cuevas
7fa5f3155a Fix docs regarding .Files.GetString and .Files.GetBytes
After #1021 ` .Files.GetString` does not exist any more.
2016-10-07 23:17:03 +02:00
Matt Butcher
1c6fc9c0e8 feat(helm): remove the requirement that fetch/install need version
This removes the requirement that a fetch or install command must
explicitly state the version number to install. Instead, this goes to
the strategy used by OS package managers: Install the latest until told
to do otherwise.

Closes #1198
2016-10-07 12:25:14 -06:00
Javier Cuevas
e8f1bf4770 Fix typo in chart docs
The name for the default values file is `values.yaml` and not `.values.yaml`.
2016-10-07 19:04:42 +02:00
Kent Rancourt
e6a9110ce0 docs(spelling): Fix some random misspellings 2016-10-06 16:46:02 -04:00
Matt Butcher
51981d62f2 docs(using_helm): change reference from npm to CPAN/Fedora DB
Closes #1271
2016-10-04 17:27:54 -06:00
Matt Butcher
6691b79f30 docs(install): Add information on using canary releases
This includes documentation on how to use Helm and Tiller canary
releases.
2016-10-04 15:48:08 -06:00
Matt Butcher
4f09b05613 feat(helm): implement new index format
This implements a new index file format for repository indices. It also
implements a new format for requirements.yaml.

Breaking change: This will break all previous versions of Helm, and will
impact helm search, repo, serve, and fetch functions.

Closes #1197
2016-10-04 13:54:14 -06:00
Matt Butcher
66e59f63e7 fix(helm): change 'helm update' to 'helm repo update'
The old form is marked deprecated.

Relates to #1196
2016-10-04 12:38:00 -06:00
Mark Petrovic
3ec83045d4 issue/1254
Fix typo in using_helm.md that refers to "glide install".  The
reference should be to "helm install".
2016-09-30 17:46:53 -07:00
Matt Butcher
715be8268e Merge pull request #1243 from rimusz-lab/docs-charts-repo-github-pages
docs(chart_repository): added github pages example
2016-09-28 16:24:33 -06:00
Rimantas Mocevicius
6eb340ed5b docs(chart_repository): added github pages example 2016-09-28 14:30:29 -06:00
Matt Butcher
47e425ba4e Merge pull request #1247 from technosophos/docs/install
docs(install, using): add installation and usage docs
2016-09-28 14:20:51 -06:00
Matt Butcher
b9a60b7d45 Merge pull request #1242 from technosophos/docs/1241-fix-values-examples
docs(charts): fix charts docs to reflect current template practices
2016-09-28 14:19:23 -06:00
Matt Butcher
7d8b5bbb49 docs(install, using): add installation and usage docs 2016-09-28 13:19:22 -06:00
Rimantas Mocevicius
8c0f905e92 docs(chart_repository): added github pages example 2016-09-28 11:00:28 -06:00
Matt Butcher
6da5bc5cee docs(charts): fix charts docs to reflect current template practices
Closes #1241
2016-09-28 10:32:35 -06:00
Matt Butcher
6f7de6d34d docs(glossary): added glossary
Added glossary to the index on README as well.

Closes #1213
2016-09-27 17:46:10 -06:00
Matt Butcher
a5921faf99 feat(chartutils): add support for requirements.yaml 2016-09-23 14:57:56 -06:00
Brandon Philips
440e548901 feat(repo): use OCI style digest identifiers
Use the same format as the Open Container Initiative for a digest
string. https://github.com/opencontainers/image-spec/blob/master/descriptor.md#digests-and-verification

Fixes #1166
2016-09-14 20:20:12 -07:00
Brandon Philips
d1488f1d94 docs(README): move history to docs/history.md
The history is helpful for people who have never heard of helm but I
don't think it is super relevant for most users.
2016-09-10 14:03:23 -07:00
Jeremy Brown
f51c729046 fix for links to docs/examples in the quickstart 2016-08-26 13:04:38 +01:00
Matt Butcher
f1d07c3f11 feat(helm): add --verify flag to commands
This adds the --verify and --keyring flags to:

helm fetch
helm inspect
helm install
helm upgrade

Each of these commands can now make cryptographic verification a
prerequisite for using a chart.
2016-08-24 13:18:26 -06:00
Matt Butcher
a46a033de4 feat(chart): support 'image:URL' in charts.
Closes #1034
2016-08-22 16:05:40 -06:00
Matt Butcher
7dadacc176 Merge pull request #1088 from jfrazelle/docs-updates
add docs table of contents and update quick start
2016-08-22 13:37:32 -06:00
Jess Frazelle
fed862985e
add docs table of contents and update quick start
Signed-off-by: Jess Frazelle <me@jessfraz.com>
2016-08-22 11:26:05 -07:00
Ville Aikas
c30a553bc1 Merge pull request #1069 from prydonius/add-notes-to-spec
docs(notes.txt): Add NOTES.txt to Chart spec, and describe chart documentation files
2016-08-22 11:05:33 -07:00
Adnan Abdulhussein
5bc96ef0b9 docs(notes.txt): move NOTES.txt to templates/NOTES.txt 2016-08-18 19:21:40 -07:00
Travis Cline
01529001ca simplify example container names
This encourages people from making container names depend on release
names.
2016-08-18 11:14:30 -07:00
Adnan Abdulhussein
9b58f1018b docs(notes.txt): Add NOTES.txt to Chart spec, and describe chart documentation 2016-08-17 15:01:18 -07:00
Jess Frazelle
67778cbcd1
update readme example and change repository to https
Signed-off-by: Jess Frazelle <me@jessfraz.com>
2016-08-17 13:14:01 -07:00
Matt Butcher
ad77fedf26 docs(developers): recommend minikube
This reflects our internal decision to suggest minikube rather than
commit resources to maintaining scripts/local-cluster.sh

Closes #889
2016-08-08 16:41:21 -06:00