1 // Copyright 2019 The Kubernetes Authors. 2 // SPDX-License-Identifier: Apache-2.0 3 4 // Package kstatus contains functionality for computing the status 5 // of Kubernetes resources. 6 // 7 // The statuses defined in this package are: 8 // - InProgress 9 // - Current 10 // - Failed 11 // - Terminating 12 // - NotFound 13 // - Unknown 14 // 15 // Computing the status of a resources can be done by calling the 16 // Compute function in the status package. 17 // 18 // import ( 19 // "sigs.k8s.io/cli-utils/pkg/kstatus/status" 20 // ) 21 // 22 // res, err := status.Compute(resource) 23 // 24 // The package also defines a set of new conditions: 25 // - InProgress 26 // - Failed 27 // 28 // These conditions have been chosen to follow the 29 // "abnormal-true" pattern where conditions should be set to true 30 // for error/abnormal conditions and the absence of a condition means 31 // things are normal. 32 // 33 // The Augment function augments any unstructured resource with 34 // the standard conditions described above. The values of 35 // these conditions are decided based on other status information 36 // available in the resources. 37 // 38 // import ( 39 // "sigs.k8s.io/cli-utils/pkg/kstatus/status 40 // ) 41 // 42 // err := status.Augment(resource) 43 package status 44