...

Source file src/sigs.k8s.io/cli-utils/pkg/kstatus/doc.go

Documentation: sigs.k8s.io/cli-utils/pkg/kstatus

     1  // Copyright 2019 The Kubernetes Authors.
     2  // SPDX-License-Identifier: Apache-2.0
     3  
     4  // Package kstatus contains libraries for computing status of Kubernetes
     5  // resource objects.
     6  //
     7  // status
     8  // Compute the status of Kubernetes resource objects.
     9  //
    10  // polling
    11  // Poll the cluster for the state of the specified resource objects and compute
    12  // the status for each as well as the aggregate status. The polling will
    13  // continue until either all resources have reached the desired status or the
    14  // polling is cancelled by the caller.
    15  //
    16  // watcher
    17  // Watch the cluster for the state of the specified resource objects and compute
    18  // the status for each. The watching will continue until cancelled by the
    19  // caller.
    20  //
    21  // A common use case for this would to be poll/watch until all resource objects
    22  // finish reconciling after apply.
    23  package kstatus
    24  

View as plain text