Skip to content

Commit

Permalink
Updates doc with API spec for images
Browse files Browse the repository at this point in the history
Signed-off-by: Somtochi Onyekwere <somtochionyekwere@gmail.com>
  • Loading branch information
somtochiama committed Dec 9, 2020
1 parent bbf5f2e commit cf8bf1f
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/spec/v1beta1/kustomization.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ type KustomizationSpec struct {
// A list of resources to be included in the health assessment.
// +optional
HealthChecks []CrossNamespaceObjectReference `json:"healthChecks,omitempty"`

// A list of images that is used for changing the image name/tag in the kustomization yaml.
// +optional
Images []Image `json:"images,omitempty"`

// The name of the Kubernetes service account to impersonate
// when reconciling this Kustomization.
Expand Down Expand Up @@ -108,6 +112,24 @@ type KubeConfig struct {
}
```

The image type contains the name, new name and new tag that will replace the original image.

```go
type Image struct {
// Name of the image to be replaced.
// +required
Name string `json:"name"`

// NewName is the name of the image used to replace the original one.
// +required
NewName string `json:"newName"`

// NewTag is the tag used to replace the original tag.
// +required
NewTag string `json:"newTag"`
}
```

The status sub-resource records the result of the last reconciliation:

```go
Expand Down

0 comments on commit cf8bf1f

Please sign in to comment.