API Reference

Packages

appstudio.redhat.com/v1alpha1

Package v1alpha1 contains API Schema definitions for the appstudio.redhat.com v1alpha1 API group

Resource Types

CredentialsStatus

CredentialsStatus shows information about generated image repository credentials.

Appears in:

Field Description
generationTimestamp Time GenerationTime shows timestamp when the current credentials were generated.
push-secret string PushSecretName holds name of the dockerconfig secret with credentials to push (and pull) into the generated repository.
pull-secret string PullSecretName is present only if ImageRepository has labels that connect it to Application and Component. Holds name of the dockerconfig secret with credentials to pull only from the generated repository. The secret might not be present in the same namespace as ImageRepository, but created in other environments.
push-robot-account string PushRobotAccountName holds name of the quay robot account with write (push and pull) permissions into the generated repository.
pull-robot-account string PullRobotAccountName is present only if ImageRepository has labels that connect it to Application and Component. Holds name of the quay robot account with real (pull only) permissions from the generated repository.

ImageCredentials

Appears in:

Field Description
regenerate-token boolean RegenerateToken defines a request to refresh image accessing credentials. Refreshes both, push and pull tokens. The field gets cleared after the refresh.
verify-linking boolean VerifyLinking defines a request to verify and fix secret linking in pipeline service account. The field gets cleared after fixing.

ImageParameters

ImageParameters describes requested image repository configuration.

Appears in:

Field Description
name string Name of the image within configured Quay organization. If ommited, then defaults to “cr-namespace/cr-name”. This field cannot be changed after the resource creation.
visibility ImageVisibility Visibility defines whether the image is publicly visible. Allowed values are public and private. “public” is the default.

ImageRepository

ImageRepository is the Schema for the imagerepositories API

Appears in:

Field Description
apiVersion string appstudio.redhat.com/v1alpha1
kind string ImageRepository
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ImageRepositorySpec  

ImageRepositoryList

ImageRepositoryList contains a list of ImageRepository

Field Description
apiVersion string appstudio.redhat.com/v1alpha1
kind string ImageRepositoryList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ImageRepository array  

ImageRepositorySpec

ImageRepositorySpec defines the desired state of ImageRepository

Appears in:

Field Description
image ImageParameters Requested image repository configuration.
credentials ImageCredentials Credentials management.
notifications Notifications array Notifications defines configuration for image repository notifications.

ImageRepositoryState

Underlying type: string

Appears in:

ImageStatus

ImageStatus shows actual generated image repository parameters.

Appears in:

Field Description
url string URL is the full image repository url to push into / pull from.
visibility ImageVisibility Visibility shows actual generated image repository visibility.

ImageVisibility

Underlying type: string

Appears in:

NotificationConfig

Appears in:

Field Description
email string Email is the email address to send notifications to.
url string Webhook is the URL to send notifications to.

NotificationEvent

Underlying type: string

Appears in:

NotificationMethod

Underlying type: string

Appears in:

NotificationStatus

NotificationStatus shows the status of the notification configuration.

Appears in:

Field Description
title string  
uuid string  

Notifications

Appears in:

Field Description
title string  
event NotificationEvent  
method NotificationMethod  
config NotificationConfig