← Back to index Esc
Kind
Appproject
Group
argoproj.io
Version
v1alpha1
apiVersion: argoproj.io/v1alpha1 kind: Appproject metadata: name: example
View raw schema
apiVersion string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind string
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata object required
spec object required
AppProjectSpec is the specification of an AppProject
clusterResourceBlacklist []object
ClusterResourceBlacklist contains list of blacklisted cluster level resources
group string required
kind string required
name string
Name is the name of the restricted resource. Glob patterns using Go's filepath.Match syntax are supported. Unlike the group and kind fields, if no name is specified, all resources of the specified group/kind are matched.
clusterResourceWhitelist []object
ClusterResourceWhitelist contains list of whitelisted cluster level resources
group string required
kind string required
name string
Name is the name of the restricted resource. Glob patterns using Go's filepath.Match syntax are supported. Unlike the group and kind fields, if no name is specified, all resources of the specified group/kind are matched.
description string
Description contains optional project description
maxLength: 255
destinationServiceAccounts []object
DestinationServiceAccounts holds information about the service accounts to be impersonated for the application sync operation for each destination.
defaultServiceAccount string required
DefaultServiceAccount to be used for impersonation during the sync operation
namespace string
Namespace specifies the target namespace for the application's resources.
server string required
Server specifies the URL of the target cluster's Kubernetes control plane API.
destinations []object
Destinations contains list of destinations available for deployment
name string
Name is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.
namespace string
Namespace specifies the target namespace for the application's resources. The namespace will only be set for namespace-scoped resources that have not set a value for .metadata.namespace
server string
Server specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.
namespaceResourceBlacklist []object
NamespaceResourceBlacklist contains list of blacklisted namespace level resources
group string required
kind string required
namespaceResourceWhitelist []object
NamespaceResourceWhitelist contains list of whitelisted namespace level resources
group string required
kind string required
orphanedResources object
OrphanedResources specifies if controller should monitor orphaned resources of apps in this project
ignore []object
Ignore contains a list of resources that are to be excluded from orphaned resources monitoring
group string
kind string
name string
warn boolean
Warn indicates if warning condition should be created for apps which have orphaned resources
permitOnlyProjectScopedClusters boolean
PermitOnlyProjectScopedClusters determines whether destinations can only reference clusters which are project-scoped
roles []object
Roles are user defined RBAC roles associated with this project
description string
Description is a description of the role
groups []string
Groups are a list of OIDC group claims bound to this role
jwtTokens []object
JWTTokens are a list of generated JWT tokens bound to this role
exp integer
format: int64
iat integer required
format: int64
id string
name string required
Name is a name for this role
policies []string
Policies Stores a list of casbin formatted strings that define access policies for the role in the project
signatureKeys []object
SignatureKeys contains a list of PGP key IDs that commits in Git must be signed with in order to be allowed for sync
keyID string required
The ID of the key in hexadecimal notation
sourceNamespaces []string
SourceNamespaces defines the namespaces application resources are allowed to be created in
sourceRepos []string
SourceRepos contains list of repository URLs which can be used for deployment
syncWindows []object
SyncWindows controls when syncs can be run for apps in this project
andOperator boolean
UseAndOperator use AND operator for matching applications, namespaces and clusters instead of the default OR operator
applications []string
Applications contains a list of applications that the window will apply to
clusters []string
Clusters contains a list of clusters that the window will apply to
description string
Description of the sync that will be applied to the schedule, can be used to add any information such as a ticket number for example
duration string
Duration is the amount of time the sync window will be open
kind string
Kind defines if the window allows or blocks syncs
manualSync boolean
ManualSync enables manual syncs when they would otherwise be blocked
namespaces []string
Namespaces contains a list of namespaces that the window will apply to
schedule string
Schedule is the time the window will begin, specified in cron format
timeZone string
TimeZone of the sync that will be applied to the schedule
status object
AppProjectStatus contains status information for AppProject CRs
jwtTokensByRole object
JWTTokensByRole contains a list of JWT tokens issued for a given role
Copied!