pkgdocs

Documentation

Overview

Code generated by "mdtogo"; DO NOT EDIT.

Index

• Variables

Variables

var DescExamples = `
  # display description for the local hello-world package
  kpt pkg desc hello-world/
`

var DescLong = `
  kpt pkg desc DIR
  
  DIR:
    Path to a package directory
`

var DescShort = `Display upstream package metadata`

var DiffExamples = `` /* 723-byte string literal not displayed */

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

var DiffShort = `Diff a local package against upstream`

var FixExamples = `` /* 194-byte string literal not displayed */

var FixLong = `` /* 344-byte string literal not displayed */

var FixShort = `Fix a local package which is using deprecated features.`

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

var GetLong = `` /* 1525-byte string literal not displayed */

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

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

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

var InitShort = `Initialize an empty package`

var PkgExamples = `` /* 492-byte string literal not displayed */

var PkgLong = `
|              Reads From | Writes To                |
|-------------------------|--------------------------|
| git repository          | local directory          |

The ` + "`" + `pkg` + "`" + ` command group contains subcommands which read remote upstream
git repositories, and write local directories.  They are focused on
providing porcelain on top of workflows which would otherwise require
wrapping git to pull clone subdirectories and perform updates by merging
resources rather than files.
`

var PkgShort = `Fetch, update, and sync configuration files using git`

var SetExamples = `` /* 546-byte string literal not displayed */

var SetLong = `
  kpt pkg set REPO_URI[.git]/PKG_PATH[@VERSION] LOCAL_DEST_DIRECTORY [flags]
  
  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.
    e.g. https://github.com/kubernetes/examples.git
    Specify - to read Resources from stdin and write to a LOCAL_DEST_DIRECTORY
  
  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 repository master branch.
    e.g. @master
  
  LOCAL_DEST_DIRECTORY:
    The local directory to write the package to. e.g. ./my-cockroachdb-copy
  
      * If the directory does NOT exist: create the specified directory and write
        the package contents to it
      * If the directory DOES exist: create a NEW directory under the specified one,
        defaulting the name to the Base of REPO/PKG_PATH
      * If the directory DOES exist and already contains a directory with the same name
        of the one that would be created: fail

Flags:

  --strategy:
    Controls how changes to the local package are handled.
    Defaults to fast-forward.
  
      * resource-merge: perform a structural comparison of the original /
        updated Resources, and merge the changes into the local package.
        See ` + "`" + `kpt help apis merge3` + "`" + ` for details on merge.
      * fast-forward: fail without updating if the local package was modified
        since it was fetched.
      * alpha-git-patch: use 'git format-patch' and 'git am' to apply a
        patch of the changes between the source version and destination
        version.
        REQUIRES THE LOCAL PACKAGE TO HAVE BEEN COMMITTED TO A LOCAL GIT REPO.
      * force-delete-replace: THIS WILL WIPE ALL LOCAL CHANGES TO
        THE PACKAGE.  DELETE the local package at local_pkg_dir/ and replace
        it with the remote version.
`

var SetShort = `Add a sync dependency to a Kptfile`

var SyncExamples = `
  # print the dependencies that would be modified
  kpt pkg sync . --dry-run

  # sync the dependencies
  kpt pkg sync .
`

var SyncLong = `` /* 271-byte string literal not displayed */

var SyncShort = `Fetch and update packages declaratively`

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

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

var UpdateShort = `Apply upstream package updates`