mirror of https://github.com/helm/helm
Keith Burdis
7 years ago
commit
ab91769e0c
@ -0,0 +1,9 @@
|
||||
<!-- If you need help or think you have found a bug, please help us with your issue by entering the following information (otherwise you can delete this text): -->
|
||||
|
||||
Output of `helm version`:
|
||||
|
||||
Output of `kubectl version`:
|
||||
|
||||
Cloud Provider/Platform (AKS, GKE, Minikube etc.):
|
||||
|
||||
|
||||
Binary file not shown.
@ -0,0 +1,37 @@
|
||||
# Custom Resource Definitions
|
||||
|
||||
This section of the Best Practices Guide deals with creating and using Custom Resource Definition
|
||||
objects.
|
||||
|
||||
When working with Custom Resource Definitions (CRDs), it is important to distinguish
|
||||
two different pieces:
|
||||
|
||||
- There is a declaration of a CRD. This is the YAML file that has the kind `CustomResourceDefinition`
|
||||
- Then there are resources that _use_ the CRD. Say a CRD defines `foo.example.com/v1`. Any resource
|
||||
that has `apiVersion: example.com/v1` and kind `Foo` is a resource that uses the CRD.
|
||||
|
||||
## Install a CRD Declaration Before Using the Resource
|
||||
|
||||
Helm is optimized to load as many resources into Kubernetes as fast as possible.
|
||||
By design, Kubernetes can take an entire set of manifests and bring them all
|
||||
online (this is called the reconciliation loop).
|
||||
|
||||
But there's a difference with CRDs.
|
||||
|
||||
For a CRD, the declaration must be registered before any resources of that CRDs
|
||||
kind(s) can be used. And the registration process sometimes takes a few seconds.
|
||||
|
||||
### Method 1: Separate Charts
|
||||
|
||||
One way to do this is to put the CRD definition in one chart, and then put any
|
||||
resources that use that CRD in _another_ chart.
|
||||
|
||||
In this method, each chart must be installed separately.
|
||||
|
||||
### Method 2: Pre-install Hooks
|
||||
|
||||
To package the two together, add a `pre-install` hook to the CRD definition so
|
||||
that it is fully installed before the rest of the chart is executed.
|
||||
|
||||
Note that if you create the CRD with a `pre-install` hook, that CRD definition
|
||||
will not be deleted when `helm delete` is run.
|
||||
@ -1,38 +0,0 @@
|
||||
# Third Party Resources
|
||||
|
||||
This section of the Best Practices Guide deals with creating and using Third Party Resource
|
||||
objects.
|
||||
|
||||
When working with Third Party Resources (TPRs), it is important to distinguish
|
||||
two different pieces:
|
||||
|
||||
- There is a declaration of a TPR. This is the YAML file that has the kind `ThirdPartyResource`
|
||||
- Then there are resources that _use_ the TPR. Say a TPR defines `foo.example.com/v1`. Any resource
|
||||
that has `apiVersion: example.com/v1` and kind `Foo` is a resource that uses the
|
||||
TPR.
|
||||
|
||||
## Install a TPR Declaration Before Using the Resource
|
||||
|
||||
Helm is optimized to load as many resources into Kubernetes as fast as possible.
|
||||
By design, Kubernetes can take an entire set of manifests and bring them all
|
||||
online (this is called the reconciliation loop).
|
||||
|
||||
But there's a difference with TPRs.
|
||||
|
||||
For a TPR, the declaration must be registered before any resources of that TPRs
|
||||
kind(s) can be used. And the registration process sometimes takes a few seconds.
|
||||
|
||||
### Method 1: Separate Charts
|
||||
|
||||
One way to do this is to put the TPR definition in one chart, and then put any
|
||||
resources that use that TPR in _another_ chart.
|
||||
|
||||
In this method, each chart must be installed separately.
|
||||
|
||||
### Method 2: Pre-install Hooks
|
||||
|
||||
To package the two together, add a `pre-install` hook to the TPR definition so
|
||||
that it is fully installed before the rest of the chart is executed.
|
||||
|
||||
Note that if you create the TPR with a `pre-install` hook, that TPR definition
|
||||
will not be deleted when `helm delete` is run.
|
||||
@ -0,0 +1,43 @@
|
||||
## helm inspect readme
|
||||
|
||||
shows inspect readme
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
|
||||
This command inspects a chart (directory, file, or URL) and displays the contents
|
||||
of the README file
|
||||
|
||||
|
||||
```
|
||||
helm inspect readme [CHART]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--ca-file string chart repository url where to locate the requested chart
|
||||
--cert-file string verify certificates of HTTPS-enabled servers using this CA bundle
|
||||
--key-file string identify HTTPS client using this SSL key file
|
||||
--keyring string path to the keyring containing public verification keys (default "~/.gnupg/pubring.gpg")
|
||||
--repo string chart repository url where to locate the requested chart
|
||||
--verify verify the provenance data for this chart
|
||||
--version string version of the chart. By default, the newest chart is shown
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--host string address of Tiller. Overrides $HELM_HOST
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
|
||||
--tiller-namespace string namespace of Tiller (default "kube-system")
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
* [helm inspect](helm_inspect.md) - inspect a chart
|
||||
|
||||
###### Auto generated by spf13/cobra on 14-Mar-2018
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue