pkgdocs

Documentation

Overview

Code generated by "mdtogo"; DO NOT EDIT.

Index

• Variables

Variables

var CatExamples = `` /* 134-byte string literal not displayed */

var CatLong = `` /* 201-byte string literal not displayed */

var CatShort = `Print the resources in a file/directory`

var DiffExamples = `

  # Show changes in current package relative to upstream source package.
  $ kpt pkg diff
`

var DiffLong = `` /* 2200-byte string literal not displayed */

var DiffShort = `Show differences between a local package and upstream.`

var GetExamples = `` /* 1020-byte string literal not displayed */

var GetLong = `
  kpt pkg get REPO_URI[.git]/PKG_PATH[@VERSION] [LOCAL_DEST_DIRECTORY] [flags]

Args:

  REPO_URI:
    URI of a git repository containing 1 or more packages as subdirectories.
    In most cases the .git suffix should be specified to delimit the REPO_URI
    from the PKG_PATH, but this is not required for widely recognized repo
    prefixes. If get cannot parse the repo for the directory and version,
    then it will print an error asking for '.git' to be specified as part of
    the argument.
  
  PKG_PATH:
    Path to remote subdirectory containing Kubernetes resource configuration
    files or directories. Defaults to the root directory.
    Uses '/' as the path separator (regardless of OS).
    e.g. staging/cockroachdb
  
  VERSION:
    A git tag, branch, ref or commit for the remote version of the package
    to fetch. Defaults to the default branch of the repository.
  
  LOCAL_DEST_DIRECTORY:
    The local directory to write the package to. Defaults to a subdirectory of the
    current working directory named after the upstream package.

Flags:

  --strategy:
    Defines which strategy should be used to update the package. It defaults to
    'resource-merge'.
  
      * resource-merge: Perform a structural comparison of the original /
        updated resources, and merge the changes into the local package.
      * fast-forward: Fail without updating if the local package was modified
        since it was fetched.
      * force-delete-replace: Wipe all the local changes to the package and replace
        it with the remote version.
  
  --for-deployment:
    (Experimental) indicates if the fetched package is a deployable instance that
    will be deployed to a cluster.
    It is ` + "`" + `false` + "`" + ` by default.

Env Vars:

  KPT_CACHE_DIR:
    Controls where to cache remote packages when fetching them.
    Defaults to <HOME>/.kpt/repos/
    On macOS and Linux <HOME> is determined by the $HOME env variable, while on
    Windows it is given by the %USERPROFILE% env variable.
`

var GetShort = `Fetch a package from a git repo.`

var InitExamples = `` /* 296-byte string literal not displayed */

var InitLong = `` /* 356-byte string literal not displayed */

var InitShort = `Initialize an empty package.`

var PkgLong = `
The ` + "`" + `pkg` + "`" + ` command group contains subcommands for fetching, updating and describing ` + "`" + `kpt` + "`" + ` packages
from git repositories.
`

var PkgShort = `Get, update, and describe packages with resources`

var TreeExamples = `
  # Show resources in the current directory.
  $ kpt pkg tree
`

var TreeLong = `
  kpt pkg tree [DIR]
`

var TreeShort = `Display resources, files and packages in a tree structure.`

var UpdateExamples = `` /* 414-byte string literal not displayed */

var UpdateLong = `` /* 1551-byte string literal not displayed */

var UpdateShort = `Apply upstream package updates.`