github.com/wmuizelaar/kpt@v0.0.0-20221018115725-bd564717b2ed/internal/docs/generated/syncdocs/docs.go (about)

     1  // Code generated by "mdtogo"; DO NOT EDIT.
     2  package syncdocs
     3  
     4  var SyncShort = `Deploy packages.`
     5  var SyncLong = `
     6  The ` + "`" + `sync` + "`" + ` command group contains subcommands for deploying packages.
     7  `
     8  
     9  var CreateShort = `Create a new sync resource in the cluster.`
    10  var CreateLong = `
    11    kpt alpha sync create DEPLOYMENT_NAME [flags]
    12  
    13  Args:
    14  
    15    DEPLOYMENT_NAME:
    16      The name of the sync resource created in the cluster.
    17  
    18  Flags:
    19  
    20    --package
    21      Name of the package that should be deployed. It must exist in a
    22      deployment repo and be published.
    23  `
    24  var CreateExamples = `
    25    # get a specific package in the default namespace
    26    $ kpt alpha sync create my-app --package=deployment-8f9a0c7bf29eb2cbac9476319cd1ad2e897be4f9 --namespace=default
    27  `
    28  
    29  var DeleteShort = `Remove a sync resource from the cluster.`
    30  var DeleteLong = `
    31    kpt alpha sync delete DEPLOYMENT_NAME [flags]
    32  
    33  Args:
    34  
    35    DEPLOYMENT_NAME:
    36      The name of the sync resource deleted from the cluster.
    37  
    38  Flags:
    39  
    40    --keep-auth-secret
    41      Do not delete the repository authentication secret, if it exists.
    42    
    43    --timeout
    44      How long we should wait for all resources to be deleted from the cluster.
    45  `
    46  var DeleteExamples = `
    47    # remove the my-app sync resource from the cluster. Wait up to 5 minutes for
    48    # resources to be deleted.
    49    $ kpt alpha sync delete my-app --timeout=5m
    50  `
    51  
    52  var GetShort = `Get sync resources from the cluster.`
    53  var GetLong = `
    54    kpt alpha sync get [DEPLOYMENT_NAME] [flags]
    55  
    56  Args:
    57  
    58    DEPLOYMENT_NAME:
    59      The name of a sync resource.
    60  `
    61  var GetExamples = `
    62    # get the sync resource named my-app from the cluster.
    63    $ kpt alpha sync get my-app
    64  `