Documentation ¶
Index ¶
- Constants
- Variables
- func DescribableResources() []string
- func DescribeClusterQuota(quota *quotaapi.ClusterResourceQuota) (string, error)
- func DescribePolicy(policy *authorizationapi.Policy) (string, error)
- func DescribePolicyBinding(policyBinding *authorizationapi.PolicyBinding) (string, error)
- func DescribePolicyRule(out *tabwriter.Writer, rule authorizationapi.PolicyRule, indent string)
- func DescribeRole(role *authorizationapi.Role) (string, error)
- func DescribeRoleBinding(roleBinding *authorizationapi.RoleBinding, role *authorizationapi.Role, ...) (string, error)
- func DescriberFor(kind unversioned.GroupKind, c *client.Client, kclient kclient.Interface, ...) (kctl.Describer, bool)
- func FormatRelativeTime(t time.Time) string
- func NewHumanReadablePrinter(printOptions kctl.PrintOptions) *kctl.HumanReadablePrinter
- func PrintTemplateParameters(params []templateapi.Parameter, output io.Writer) error
- type AppliedClusterQuotaDescriber
- type BuildConfigDescriber
- type BuildDescriber
- type ChainDescriber
- type ClusterNetworkDescriber
- type ClusterPolicyBindingDescriber
- type ClusterPolicyDescriber
- type ClusterQuotaDescriber
- type ClusterRoleBindingDescriber
- type ClusterRoleDescriber
- type DeploymentConfigDescriber
- type DepthFirst
- type DescribeWebhook
- type EgressNetworkPolicyDescriber
- type GraphLoader
- type GroupDescriber
- type HostSubnetDescriber
- type IdentityDescriber
- type ImageDescriber
- type ImageStreamDescriber
- type ImageStreamImageDescriber
- type ImageStreamTagDescriber
- type LatestDeploymentsDescriber
- type NetNamespaceDescriber
- type NodeStack
- type NotFoundErr
- type OAuthAccessTokenDescriber
- type PolicyBindingDescriber
- type PolicyDescriber
- type ProjectDescriber
- type ProjectStatusDescriber
- type RoleBindingDescriber
- type RoleBindingRestrictionDescriber
- type RoleDescriber
- type RouteDescriber
- type SortableProjects
- type TemplateDescriber
- func (d *TemplateDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
- func (d *TemplateDescriber) DescribeMessage(msg string, out *tabwriter.Writer)
- func (d *TemplateDescriber) DescribeParameters(params []templateapi.Parameter, out *tabwriter.Writer)
- func (d *TemplateDescriber) DescribeTemplate(template *templateapi.Template) (string, error)
- type UserDescriber
- type UserIdentityMappingDescriber
Constants ¶
const ForbiddenListWarning = "Forbidden"
const PolicyRuleHeadings = "Verbs\tNon-Resource URLs\tExtension\tResource Names\tAPI Groups\tResources"
Variables ¶
var ( // IsPersonalSubjectAccessReviewColumns contains known custom role extensions IsPersonalSubjectAccessReviewColumns = []string{"NAME"} )
Functions ¶
func DescribableResources ¶
func DescribableResources() []string
DescribableResources lists all of the resource types we can describe
func DescribeClusterQuota ¶ added in v1.3.0
func DescribeClusterQuota(quota *quotaapi.ClusterResourceQuota) (string, error)
func DescribePolicy ¶
func DescribePolicy(policy *authorizationapi.Policy) (string, error)
func DescribePolicyBinding ¶
func DescribePolicyBinding(policyBinding *authorizationapi.PolicyBinding) (string, error)
func DescribePolicyRule ¶ added in v1.3.0
func DescribePolicyRule(out *tabwriter.Writer, rule authorizationapi.PolicyRule, indent string)
func DescribeRole ¶
func DescribeRole(role *authorizationapi.Role) (string, error)
func DescribeRoleBinding ¶
func DescribeRoleBinding(roleBinding *authorizationapi.RoleBinding, role *authorizationapi.Role, err error) (string, error)
DescribeRoleBinding prints out information about a role binding and its associated role
func DescriberFor ¶
func DescriberFor(kind unversioned.GroupKind, c *client.Client, kclient kclient.Interface, host string) (kctl.Describer, bool)
DescriberFor returns a describer for a given kind of resource
func FormatRelativeTime ¶ added in v1.0.7
FormatRelativeTime converts a time field into a human readable age string (hours, minutes, days).
func NewHumanReadablePrinter ¶
func NewHumanReadablePrinter(printOptions kctl.PrintOptions) *kctl.HumanReadablePrinter
NewHumanReadablePrinter returns a new HumanReadablePrinter
func PrintTemplateParameters ¶
func PrintTemplateParameters(params []templateapi.Parameter, output io.Writer) error
PrintTemplateParameters the Template parameters with their default values
Types ¶
type AppliedClusterQuotaDescriber ¶ added in v1.3.0
func (*AppliedClusterQuotaDescriber) Describe ¶ added in v1.3.0
func (d *AppliedClusterQuotaDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
type BuildConfigDescriber ¶
BuildConfigDescriber generates information about a buildConfig
func (*BuildConfigDescriber) Describe ¶
func (d *BuildConfigDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a buildConfig
func (*BuildConfigDescriber) DescribeTriggers ¶
func (d *BuildConfigDescriber) DescribeTriggers(bc *buildapi.BuildConfig, out *tabwriter.Writer)
DescribeTriggers generates information about the triggers associated with a buildconfig
type BuildDescriber ¶
type BuildDescriber struct {
// contains filtered or unexported fields
}
BuildDescriber generates information about a build
func (*BuildDescriber) Describe ¶
func (d *BuildDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a build
type ChainDescriber ¶ added in v1.0.4
type ChainDescriber struct {
// contains filtered or unexported fields
}
ChainDescriber generates extended information about a chain of dependencies of an image stream
func NewChainDescriber ¶ added in v1.0.4
func NewChainDescriber(c client.BuildConfigsNamespacer, namespaces sets.String, out string) *ChainDescriber
NewChainDescriber returns a new ChainDescriber
func (*ChainDescriber) Describe ¶ added in v1.0.4
func (d *ChainDescriber) Describe(ist *imageapi.ImageStreamTag, includeInputImages, reverse bool) (string, error)
Describe returns the output of the graph starting from the provided image stream tag (name:tag) in namespace. Namespace is needed here because image stream tags with the same name can be found across different namespaces.
type ClusterNetworkDescriber ¶ added in v1.3.0
func (*ClusterNetworkDescriber) Describe ¶ added in v1.3.0
func (d *ClusterNetworkDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a ClusterNetwork
type ClusterPolicyBindingDescriber ¶
ClusterPolicyBindingDescriber generates information about a Project
func (*ClusterPolicyBindingDescriber) Describe ¶
func (d *ClusterPolicyBindingDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a policyBinding
type ClusterPolicyDescriber ¶
ClusterPolicyDescriber generates information about a Project
func (*ClusterPolicyDescriber) Describe ¶
func (d *ClusterPolicyDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a policy TODO make something a lot prettier
type ClusterQuotaDescriber ¶ added in v1.3.0
func (*ClusterQuotaDescriber) Describe ¶ added in v1.3.0
func (d *ClusterQuotaDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
type ClusterRoleBindingDescriber ¶
ClusterRoleBindingDescriber generates information about a Project
func (*ClusterRoleBindingDescriber) Describe ¶
func (d *ClusterRoleBindingDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a roleBinding
type ClusterRoleDescriber ¶
func (*ClusterRoleDescriber) Describe ¶
func (d *ClusterRoleDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a role
type DeploymentConfigDescriber ¶
type DeploymentConfigDescriber struct {
// contains filtered or unexported fields
}
DeploymentConfigDescriber generates information about a DeploymentConfig
func NewDeploymentConfigDescriber ¶
func NewDeploymentConfigDescriber(client client.Interface, kclient kclient.Interface, config *deployapi.DeploymentConfig) *DeploymentConfigDescriber
NewDeploymentConfigDescriber returns a new DeploymentConfigDescriber
func (*DeploymentConfigDescriber) Describe ¶
func (d *DeploymentConfigDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a DeploymentConfig
type DepthFirst ¶ added in v1.0.5
type DepthFirst struct { EdgeFilter func(graph.Edge) bool Visit func(u, v graph.Node) // contains filtered or unexported fields }
DepthFirst implements stateful depth-first graph traversal. Modifies behavior of visitor.DepthFirst to allow nodes to be visited multiple times as long as they're not in the current stack
type DescribeWebhook ¶ added in v1.3.0
DescribeWebhook holds the URL information about a webhook and for generic webhooks it tells us if we allow env variables.
type EgressNetworkPolicyDescriber ¶ added in v1.3.0
type EgressNetworkPolicyDescriber struct {
// contains filtered or unexported fields
}
func (*EgressNetworkPolicyDescriber) Describe ¶ added in v1.3.0
func (d *EgressNetworkPolicyDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of an EgressNetworkPolicy
type GraphLoader ¶ added in v1.0.2
type GraphLoader interface { // Load is responsible for gathering and saving the objects this GraphLoader should AddToGraph Load() error // AddToGraph AddToGraph(g osgraph.Graph) error }
GraphLoader is a stateful interface that provides methods for building the nodes of a graph
type GroupDescriber ¶ added in v1.0.4
type GroupDescriber struct {
// contains filtered or unexported fields
}
GroupDescriber generates information about a group
func (*GroupDescriber) Describe ¶ added in v1.0.4
func (d *GroupDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a group
type HostSubnetDescriber ¶ added in v1.3.0
func (*HostSubnetDescriber) Describe ¶ added in v1.3.0
func (d *HostSubnetDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a HostSubnet
type IdentityDescriber ¶
IdentityDescriber generates information about a user
func (*IdentityDescriber) Describe ¶
func (d *IdentityDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of an identity
type ImageDescriber ¶
ImageDescriber generates information about a Image
func (*ImageDescriber) Describe ¶
func (d *ImageDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of an image
type ImageStreamDescriber ¶
ImageStreamDescriber generates information about a ImageStream (Image).
func (*ImageStreamDescriber) Describe ¶
func (d *ImageStreamDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of an imageStream
type ImageStreamImageDescriber ¶
ImageStreamImageDescriber generates information about a ImageStreamImage (Image).
func (*ImageStreamImageDescriber) Describe ¶
func (d *ImageStreamImageDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of an imageStreamImage
type ImageStreamTagDescriber ¶
ImageStreamTagDescriber generates information about a ImageStreamTag (Image).
func (*ImageStreamTagDescriber) Describe ¶
func (d *ImageStreamTagDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of an imageStreamTag
type LatestDeploymentsDescriber ¶
type LatestDeploymentsDescriber struct {
// contains filtered or unexported fields
}
func NewLatestDeploymentsDescriber ¶
func NewLatestDeploymentsDescriber(client client.Interface, kclient kclient.Interface, count int) *LatestDeploymentsDescriber
NewLatestDeploymentsDescriber lists the latest deployments limited to "count". In case count == -1, list back to the last successful.
type NetNamespaceDescriber ¶ added in v1.3.0
func (*NetNamespaceDescriber) Describe ¶ added in v1.3.0
func (d *NetNamespaceDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a NetNamespace
type NodeStack ¶ added in v1.0.7
NodeStack implements a LIFO stack of graph.Node. NodeStack is internal only in go 1.5.
type NotFoundErr ¶ added in v1.0.4
type NotFoundErr string
NotFoundErr is returned when the imageStreamTag (ist) of interest cannot be found in the graph. This doesn't mean though that the IST does not exist. A user may have an image stream without a build configuration pointing at it. In that case, the IST of interest simply doesn't have other dependant ists
func (NotFoundErr) Error ¶ added in v1.0.4
func (e NotFoundErr) Error() string
type OAuthAccessTokenDescriber ¶ added in v1.3.0
OAuthAccessTokenDescriber generates information about an OAuth Acess Token (OAuth)
func (*OAuthAccessTokenDescriber) Describe ¶ added in v1.3.0
func (d *OAuthAccessTokenDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
type PolicyBindingDescriber ¶
PolicyBindingDescriber generates information about a Project
func (*PolicyBindingDescriber) Describe ¶
func (d *PolicyBindingDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a policyBinding
type PolicyDescriber ¶
PolicyDescriber generates information about a Project
func (*PolicyDescriber) Describe ¶
func (d *PolicyDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a policy TODO make something a lot prettier
type ProjectDescriber ¶
type ProjectDescriber struct {
// contains filtered or unexported fields
}
ProjectDescriber generates information about a Project
func (*ProjectDescriber) Describe ¶
func (d *ProjectDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a project
type ProjectStatusDescriber ¶
type ProjectStatusDescriber struct { // TODO internalclientset: get rid of oldClient after next rebase OldK kclient.Interface K kclientset.Interface C client.Interface Server string Suggest bool // root command used when calling this command CommandBaseName string Config *restclient.Config LogsCommandName string SecurityPolicyCommandFormat string SetProbeCommandName string }
ProjectStatusDescriber generates extended information about a Project
type RoleBindingDescriber ¶
RoleBindingDescriber generates information about a Project
func (*RoleBindingDescriber) Describe ¶
func (d *RoleBindingDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a roleBinding
type RoleBindingRestrictionDescriber ¶ added in v1.4.0
func (*RoleBindingRestrictionDescriber) Describe ¶ added in v1.4.0
func (d *RoleBindingRestrictionDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a RoleBindingRestriction.
type RoleDescriber ¶
RoleDescriber generates information about a Project
func (*RoleDescriber) Describe ¶
func (d *RoleDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a role
type RouteDescriber ¶
RouteDescriber generates information about a Route
func (*RouteDescriber) Describe ¶
func (d *RouteDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a route
type SortableProjects ¶
type SortableProjects []projectapi.Project
SortableProjects is a list of projects that can be sorted
func (SortableProjects) Len ¶
func (list SortableProjects) Len() int
func (SortableProjects) Less ¶
func (list SortableProjects) Less(i, j int) bool
func (SortableProjects) Swap ¶
func (list SortableProjects) Swap(i, j int)
type TemplateDescriber ¶
type TemplateDescriber struct { client.Interface meta.MetadataAccessor runtime.ObjectTyper kctl.ObjectDescriber }
TemplateDescriber generates information about a template
func (*TemplateDescriber) Describe ¶
func (d *TemplateDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a template
func (*TemplateDescriber) DescribeMessage ¶ added in v1.3.0
func (d *TemplateDescriber) DescribeMessage(msg string, out *tabwriter.Writer)
DescribeMessage prints the message that will be parameter substituted and displayed to the user when this template is processed.
func (*TemplateDescriber) DescribeParameters ¶
func (d *TemplateDescriber) DescribeParameters(params []templateapi.Parameter, out *tabwriter.Writer)
DescribeParameters prints out information about the parameters of a template
func (*TemplateDescriber) DescribeTemplate ¶
func (d *TemplateDescriber) DescribeTemplate(template *templateapi.Template) (string, error)
type UserDescriber ¶
UserDescriber generates information about a user
func (*UserDescriber) Describe ¶
func (d *UserDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a user
type UserIdentityMappingDescriber ¶
UserIdentityMappingDescriber generates information about a user
func (*UserIdentityMappingDescriber) Describe ¶
func (d *UserIdentityMappingDescriber) Describe(namespace, name string, settings kctl.DescriberSettings) (string, error)
Describe returns the description of a userIdentity