CLI / API Reference on Porch Documentation

CLI Reference

Mon, 01 Jan 0001 00:00:00 +0000

Overview

porchctl is the command-line interface for interacting with Porch. It communicates with a Kubernetes API server that has Porch installed as an aggregated API server, allowing you to manage repository registrations and packages within those repositories.

Installation

See Installing porchctl for installation instructions.

Global Flags

These flags are available for all porchctl commands:

Flag	Description	Default
`--kubeconfig string`	Path to kubeconfig file. Only required if out-of-cluster. Can also be set via `KUBECONFIG` environment variable.
`--log-flush-frequency duration`	Maximum seconds between log flushes	`5s`
`--truncate-output`	Enable output truncation	`true`
`-v, --v Level`	Log level verbosity
`-h, --help`	Help for porchctl

Commands

repo - Manage package repositories
rpkg - Manage packages
completion - Generate shell autocompletion
version - Print version information

repo

Manage package repositories.

API Reference

Mon, 01 Jan 0001 00:00:00 +0000

Packages

porch.kpt.dev/v1alpha1

porch.kpt.dev/v1alpha1

Condition

Appears in:

PackageRevisionStatus

Field	Description	Default	Validation
`type` string
`status` ConditionStatus
`reason` string
`message` string

ConditionStatus

Appears in:

Condition

Field	Description
`True`
`False`
`Unknown`

Field

Field references a field in a resource

Appears in:

ResultItem

Field	Description	Default	Validation
`path` string	Path is the field path. This field is required.
`currentValue` string	CurrentValue is the current field value
`proposedValue` string	ProposedValue is the proposed value of the field to fix an issue.

File

File references a file containing a resource

CRD Reference

Mon, 01 Jan 0001 00:00:00 +0000