update docs
Signed-off-by: Inteon <42113979+inteon@users.noreply.github.com>
This commit is contained in:
Inteon
parent
136b8ef374
commit
b4f65b47ed
65
LICENSES
65
LICENSES
@ -16928,6 +16928,36 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
================================================================================
|
||||
|
||||
|
||||
================================================================================
|
||||
= vendor/github.com/stretchr/objx licensed under: =
|
||||
|
||||
The MIT License
|
||||
|
||||
Copyright (c) 2014 Stretchr, Inc.
|
||||
Copyright (c) 2017-2018 objx contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
= vendor/github.com/stretchr/objx/LICENSE d023fd31d3ca39ec61eec65a91732735
|
||||
================================================================================
|
||||
|
||||
|
||||
================================================================================
|
||||
= vendor/github.com/stretchr/testify licensed under: =
|
||||
|
||||
@ -17557,42 +17587,7 @@ SOFTWARE.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
<<<<<<< HEAD
|
||||
================================================================================
|
||||
= vendor/github.com/stretchr/objx licensed under: =
|
||||
|
||||
The MIT License
|
||||
|
||||
Copyright (c) 2014 Stretchr, Inc.
|
||||
Copyright (c) 2017-2018 objx contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
= vendor/github.com/stretchr/objx/LICENSE d023fd31d3ca39ec61eec65a91732735
|
||||
================================================================================
|
||||
|
||||
|
||||
================================================================================
|
||||
= vendor/github.com/stretchr/testify licensed under: =
|
||||
=======
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
>>>>>>> basic install and uninstall functionality
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
|
||||
@ -59,13 +59,13 @@ Most of the features supported by 'helm install' are also supported by this comm
|
||||
In addition his command will always install CRD resources.
|
||||
|
||||
Some example uses:
|
||||
$ kubectl cert-manager install
|
||||
$ kubectl cert-manager x install
|
||||
or
|
||||
$ kubectl cert-manager install -n new-cert-manager
|
||||
$ kubectl cert-manager x install -n new-cert-manager
|
||||
or
|
||||
$ kubectl cert-manager install --version v1.4.0
|
||||
$ kubectl cert-manager x install --version v1.4.0
|
||||
or
|
||||
$ kubectl cert-manager install --set prometheus.enabled=false
|
||||
$ kubectl cert-manager x install --set prometheus.enabled=false
|
||||
|
||||
To override values in the cert-manager chart, use either the '--values' flag and pass in a file
|
||||
or use the '--set' flag and pass configuration from the command line, to force
|
||||
@ -93,7 +93,7 @@ func NewCmdInstall(ctx context.Context, ioStreams genericclioptions.IOStreams, f
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "install",
|
||||
Short: "install cert-manager",
|
||||
Short: "Install cert-manager",
|
||||
Long: installDesc,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
if err := helm.CopyCliFlags(cmd.Root().PersistentFlags(), defaults, settings); err != nil {
|
||||
@ -116,9 +116,9 @@ func NewCmdInstall(ctx context.Context, ioStreams genericclioptions.IOStreams, f
|
||||
addValueOptionsFlags(cmd.Flags(), options.valueOpts)
|
||||
addChartPathOptionsFlags(cmd.Flags(), &options.client.ChartPathOptions)
|
||||
|
||||
cmd.Flags().BoolVar(&options.client.CreateNamespace, "create-namespace", true, "create the release namespace if not present")
|
||||
cmd.Flags().StringVar(&options.ChartName, "chart-name", "cert-manager", "name of the chart to install")
|
||||
cmd.Flags().BoolVar(&options.DryRun, "dry-run", false, "simulate install and output manifest")
|
||||
cmd.Flags().BoolVar(&options.client.CreateNamespace, "create-namespace", true, "Create the release namespace if not present")
|
||||
cmd.Flags().StringVar(&options.ChartName, "chart-name", "cert-manager", "Name of the chart to install")
|
||||
cmd.Flags().BoolVar(&options.DryRun, "dry-run", false, "Simulate install and output manifest")
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
||||
@ -52,11 +52,11 @@ The tool tries to find a Helm-based cert-manager install (installed directly by
|
||||
by this cli tool) and removes the resources based on the found Helm release.
|
||||
|
||||
Some example uses:
|
||||
$ kubectl cert-manager uninstall
|
||||
$ kubectl cert-manager x uninstall
|
||||
or
|
||||
$ kubectl cert-manager uninstall --remove-crds
|
||||
$ kubectl cert-manager x uninstall --remove-crds
|
||||
or
|
||||
$ kubectl cert-manager uninstall -n new-cert-manager
|
||||
$ kubectl cert-manager x uninstall -n new-cert-manager
|
||||
`
|
||||
|
||||
type UninstallOptions struct {
|
||||
@ -90,7 +90,7 @@ func NewCmdUninstall(ctx context.Context, ioStreams genericclioptions.IOStreams,
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "uninstall",
|
||||
Short: "uninstall cert-manager",
|
||||
Short: "Uninstall cert-manager",
|
||||
Long: uninstallDesc,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
if err := helm.CopyCliFlags(cmd.Root().PersistentFlags(), defaults, settings); err != nil {
|
||||
@ -106,8 +106,8 @@ func NewCmdUninstall(ctx context.Context, ioStreams genericclioptions.IOStreams,
|
||||
|
||||
addInstallUninstallFlags(cmd.Flags(), &options.client.Timeout, &options.client.Wait)
|
||||
|
||||
cmd.Flags().BoolVar(&options.RemoveCrds, "remove-crds", false, "also remove crds")
|
||||
cmd.Flags().StringVar(&options.ChartName, "chart-name", "cert-manager", "name of the chart to uninstall")
|
||||
cmd.Flags().BoolVar(&options.RemoveCrds, "remove-crds", false, "Also remove crds")
|
||||
cmd.Flags().StringVar(&options.ChartName, "chart-name", "Cert-manager", "name of the chart to uninstall")
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
||||
@ -30,22 +30,22 @@ import (
|
||||
|
||||
// Flags that are shared between the Install and the Uninstall command
|
||||
func addInstallUninstallFlags(f *pflag.FlagSet, timeout *time.Duration, wait *bool) {
|
||||
f.DurationVar(timeout, "timeout", 300*time.Second, "time to wait for any individual Kubernetes operation (like Jobs for hooks)")
|
||||
f.BoolVar(wait, "wait", true, "if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as --timeout")
|
||||
f.DurationVar(timeout, "timeout", 300*time.Second, "Time to wait for any individual Kubernetes operation (like Jobs for hooks)")
|
||||
f.BoolVar(wait, "wait", true, "If set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as --timeout")
|
||||
}
|
||||
|
||||
func addInstallFlags(f *pflag.FlagSet, client *action.Install) {
|
||||
f.StringVar(&client.ReleaseName, "release-name", "cert-manager", "name of the helm release")
|
||||
f.BoolVarP(&client.GenerateName, "generate-name", "g", false, "generate the name (instead of using the default 'cert-manager' value)")
|
||||
f.StringVar(&client.NameTemplate, "name-template", "", "specify template used to name the release")
|
||||
f.StringVar(&client.Description, "description", "Cert-manager was installed using the cert-manager kubectl plugin", "add a custom description")
|
||||
f.StringVar(&client.ReleaseName, "release-name", "cert-manager", "Name of the helm release")
|
||||
f.BoolVarP(&client.GenerateName, "generate-name", "g", false, "Generate the name (instead of using the default 'cert-manager' value)")
|
||||
f.StringVar(&client.NameTemplate, "name-template", "", "Specify template used to name the release")
|
||||
f.StringVar(&client.Description, "description", "Cert-manager was installed using the cert-manager kubectl plugin", "Add a custom description")
|
||||
}
|
||||
|
||||
func addValueOptionsFlags(f *pflag.FlagSet, v *values.Options) {
|
||||
f.StringSliceVarP(&v.ValueFiles, "values", "f", []string{}, "specify values in a YAML file or a URL (can specify multiple)")
|
||||
f.StringArrayVar(&v.Values, "set", []string{}, "set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)")
|
||||
f.StringArrayVar(&v.StringValues, "set-string", []string{}, "set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)")
|
||||
f.StringArrayVar(&v.FileValues, "set-file", []string{}, "set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)")
|
||||
f.StringSliceVarP(&v.ValueFiles, "values", "f", []string{}, "Specify values in a YAML file or a URL (can specify multiple)")
|
||||
f.StringArrayVar(&v.Values, "set", []string{}, "Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)")
|
||||
f.StringArrayVar(&v.StringValues, "set-string", []string{}, "Set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)")
|
||||
f.StringArrayVar(&v.FileValues, "set-file", []string{}, "Set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)")
|
||||
}
|
||||
|
||||
// defaultKeyring returns the expanded path to the default keyring.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user