Skip to content

Latest commit

 

History

History
8806 lines (7815 loc) · 220 KB

File metadata and controls

8806 lines (7815 loc) · 220 KB

API Reference

Packages:

devopsarr.io/v1alpha1

Resource Types:

SonarrAutoTag

↩ Parent

Auto-generated derived type for SonarrAutoTagSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrAutoTag true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrAutoTag represents an auto-tagging rule configuration in Sonarr Auto-tagging automatically applies tags to series based on conditions
true
status object
false

SonarrAutoTag.spec

↩ Parent

SonarrAutoTag represents an auto-tagging rule configuration in Sonarr Auto-tagging automatically applies tags to series based on conditions

Name Type Description Required
name string Auto-tag rule name
true
sonarrInstanceRef object Reference to the SonarrInstance
true
removeTagsAutomatically boolean Remove tags automatically when conditions no longer match

Default: false
false
specifications []object Specifications (conditions) for this auto-tag rule

Default: []
false
tags []integer Tags to apply when conditions match

Default: []
false

SonarrAutoTag.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrAutoTag.spec.specifications[index]

↩ Parent

Name Type Description Required
implementation enum Specification type/implementation

Enum: rootFolderSpecification, genreSpecification, yearSpecification, seriesTypeSpecification, qualityProfileSpecification, networkSpecification, originalLanguageSpecification, tagSpecification
true
name string Specification name
true
fields object Fields/values for this specification

Default: map[max: min: value:]
false
negate boolean Negate this condition

Default: false
false
required boolean This condition is required

Default: true
false

SonarrAutoTag.spec.specifications[index].fields

↩ Parent

Fields/values for this specification

Name Type Description Required
max integer Maximum value (for year specifications)

Format: int32
false
min integer Minimum value (for year specifications)

Format: int32
false
value string Value for the specification (path, genre, network, etc.)
false

SonarrAutoTag.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
id integer Sonarr Auto Tag ID

Format: int32
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrAutoTag.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrCustomFormat

↩ Parent

Auto-generated derived type for SonarrCustomFormatSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrCustomFormat true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrCustomFormat represents a custom format configuration in Sonarr Custom formats are used to score releases based on various criteria
true
status object
false

SonarrCustomFormat.spec

↩ Parent

SonarrCustomFormat represents a custom format configuration in Sonarr Custom formats are used to score releases based on various criteria

Name Type Description Required
name string Custom format name
true
sonarrInstanceRef object Reference to the SonarrInstance
true
includeCustomFormatWhenRenaming boolean Include custom format name when renaming files

Default: false
false
specifications []object Specifications (conditions) for this custom format

Default: []
false

SonarrCustomFormat.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrCustomFormat.spec.specifications[index]

↩ Parent

Name Type Description Required
implementation enum Specification type/implementation

Enum: releaseTitleSpecification, sourceSpecification, resolutionSpecification, qualityModifierSpecification, sizeSpecification, indexerFlagSpecification, languageSpecification, releaseGroupSpecification, editionSpecification
true
name string Specification name
true
fields object Fields/values for this specification

Default: map[max: min: value:]
false
negate boolean Negate this condition

Default: false
false
required boolean This condition is required

Default: true
false

SonarrCustomFormat.spec.specifications[index].fields

↩ Parent

Fields/values for this specification

Name Type Description Required
max number Maximum value (for size specifications)

Format: double
false
min number Minimum value (for size specifications)

Format: double
false
value string Value for the specification (regex pattern, source type, etc.)
false

SonarrCustomFormat.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
id integer Sonarr Custom Format ID

Format: int32
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrCustomFormat.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrDelayProfile

↩ Parent

Auto-generated derived type for SonarrDelayProfileSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrDelayProfile true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrDelayProfile represents a delay profile configuration in Sonarr Delay profiles control how long Sonarr waits before grabbing a release
true
status object
false

SonarrDelayProfile.spec

↩ Parent

SonarrDelayProfile represents a delay profile configuration in Sonarr Delay profiles control how long Sonarr waits before grabbing a release

Name Type Description Required
sonarrInstanceRef object Reference to the SonarrInstance
true
bypassIfAboveCustomFormatScore boolean Bypass delay if above custom format score

Default: false
false
bypassIfHighestQuality boolean Bypass delay if highest quality

Default: false
false
enableTorrent boolean Enable Torrent downloads

Default: true
false
enableUsenet boolean Enable Usenet downloads

Default: true
false
minimumCustomFormatScore integer Minimum custom format score to bypass delay

Format: int32
Default: 0
false
order integer Order of this profile (lower = higher priority)

Format: int32
Default: 0
false
preferredProtocol enum Preferred download protocol

Enum: usenet, torrent
Default: usenet
false
tags []integer Tags to apply this delay profile to

Default: []
false
torrentDelay integer Delay for Torrents in minutes

Format: int32
Default: 0
false
usenetDelay integer Delay for Usenet in minutes

Format: int32
Default: 0
false

SonarrDelayProfile.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrDelayProfile.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
id integer Sonarr Delay Profile ID

Format: int32
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrDelayProfile.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrDownloadClient

↩ Parent

Auto-generated derived type for SonarrDownloadClientSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrDownloadClient true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrDownloadClient represents a download client configuration in Sonarr Download clients are used to download releases (qBittorrent, Transmission, SABnzbd, etc.)
true
status object
false

SonarrDownloadClient.spec

↩ Parent

SonarrDownloadClient represents a download client configuration in Sonarr Download clients are used to download releases (qBittorrent, Transmission, SABnzbd, etc.)

Name Type Description Required
config object Download client configuration
true
downloadClientType enum Download client type

Enum: Aria2, Deluge, Flood, Hadouken, Nzbget, Nzbvortex, Pneumatic, QBittorrent, RTorrent, Sabnzbd, TorrentBlackhole, TorrentDownloadStation, Transmission, UsenetBlackhole, UsenetDownloadStation, UTorrent, Vuze
true
name string Download client name
true
sonarrInstanceRef object Reference to the SonarrInstance
true
enable boolean Enable this download client

Default: true
false
priority integer Priority for this download client

Format: int32
Default: 1
false
removeCompletedDownloads boolean Remove completed downloads

Default: true
false
removeFailedDownloads boolean Remove failed downloads

Default: true
false
tags []integer Tags for this download client

Default: []
false

SonarrDownloadClient.spec.config

↩ Parent

Download client configuration

Name Type Description Required
addPaused boolean Add paused

Default: false
false
apiKeySecretRef object API key from secret (for some clients)
false
firstAndLast boolean First and last (for qBittorrent)

Default: false
false
host string Host address
false
initialState integer Initial state (for qBittorrent: 0 = Start, 1 = ForceStart, 2 = Pause)

Format: int32
false
nzbFolder string NZB folder (for blackhole)
false
olderTvPriority integer Older TV priority (0 = Last, 1 = First)

Format: int32
false
passwordSecretRef object Password from secret
false
port integer Port number

Format: int32
false
recentTvPriority integer Recent TV priority (0 = Last, 1 = First)

Format: int32
false
rpcPath string RPC path (for Aria2)
false
saveMagnetFiles boolean Save magnet files (for blackhole)

Default: false
false
secretTokenSecretRef object Secret token (for Aria2)
false
sequentialOrder boolean Sequential order (for qBittorrent)

Default: false
false
strmFolder string Strm folder (for pneumatic)
false
torrentFolder string Torrent folder (for blackhole)
false
tvCategory string TV category
false
tvDirectory string TV directory
false
urlBase string URL base path
false
useSsl boolean Use SSL

Default: false
false
username string Username
false
watchFolder string Watch folder (for blackhole)
false

SonarrDownloadClient.spec.config.apiKeySecretRef

↩ Parent

API key from secret (for some clients)

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

SonarrDownloadClient.spec.config.passwordSecretRef

↩ Parent

Password from secret

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

SonarrDownloadClient.spec.config.secretTokenSecretRef

↩ Parent

Secret token (for Aria2)

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

SonarrDownloadClient.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrDownloadClient.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
id integer Sonarr Download Client ID

Format: int32
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrDownloadClient.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrDownloadClientConfig

↩ Parent

Auto-generated derived type for SonarrDownloadClientConfigSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrDownloadClientConfig true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrDownloadClientConfig configures global download client settings for a Sonarr instance. Only one SonarrDownloadClientConfig per Sonarr instance is allowed. Note: This is different from SonarrDownloadClient which configures individual download clients.
true
status object
false

SonarrDownloadClientConfig.spec

↩ Parent

SonarrDownloadClientConfig configures global download client settings for a Sonarr instance. Only one SonarrDownloadClientConfig per Sonarr instance is allowed. Note: This is different from SonarrDownloadClient which configures individual download clients.

Name Type Description Required
sonarrInstanceRef object Reference to the Sonarr instance
true
autoRedownloadFailed boolean Automatically redownload failed releases
false
autoRedownloadFailedFromInteractiveSearch boolean Automatically redownload failed releases from interactive search
false
downloadClientWorkingFolders string Working folders for download client (container path mapping)
false
enableCompletedDownloadHandling boolean Enable completed download handling
false

SonarrDownloadClientConfig.spec.sonarrInstanceRef

↩ Parent

Reference to the Sonarr instance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrDownloadClientConfig.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrDownloadClientConfig.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrImportList

↩ Parent

Auto-generated derived type for SonarrImportListSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrImportList true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrImportList represents an import list configuration in Sonarr Import lists automatically add series from external sources (Trakt, Plex, etc.)
true
status object
false

SonarrImportList.spec

↩ Parent

SonarrImportList represents an import list configuration in Sonarr Import lists automatically add series from external sources (Trakt, Plex, etc.)

Name Type Description Required
listType enum Import list type/implementation

Enum: sonarrImport, traktListImport, traktUserImport, traktPopularImport, plexImport, imdbListImport, customImport, simklImport, aniListImport, myAnimeListImport
true
name string Import list name
true
qualityProfileId integer Quality profile ID to use

Format: int32
true
rootFolderPath string Root folder path for imported series
true
sonarrInstanceRef object Reference to the SonarrInstance
true
config object Import list configuration

Default: map[accessToken: apiKey: authUser: baseUrl: languageProfileId: listId: listname: profileIds:[] tagIds:[] traktListType: username:]
false
enableAutomaticAdd boolean Enable automatic add

Default: true
false
listOrder integer List order

Format: int32
Default: 0
false
monitorNewItems enum Monitor new items

Enum: all, none
Default: all
false
searchForMissingEpisodes boolean Search for missing episodes when adding

Default: false
false
seasonFolder boolean Use season folders

Default: true
false
seriesType enum Series type

Enum: standard, daily, anime
Default: standard
false
shouldMonitor enum Monitor type for imported series

Enum: all, future, missing, existing, firstSeason, latestSeason, pilot, monitorSpecials, unmonitorSpecials, none
Default: all
false
tags []integer Tags for imported series

Default: []
false

SonarrImportList.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrImportList.spec.config

↩ Parent

Import list configuration

Name Type Description Required
accessToken string Access token (for Trakt/Plex)
false
apiKey string API key (for Sonarr import)
false
authUser string Auth user (for Trakt)
false
baseUrl string Base URL (for Sonarr import)
false
languageProfileId integer Language profile ID (deprecated in v4)

Format: int32
false
listId string List ID
false
listname string List name/ID
false
profileIds []integer Profile IDs (for Sonarr import)

Default: []
false
tagIds []integer Tag IDs (for Sonarr import)

Default: []
false
traktListType integer Trakt list type

Format: int32
false
username string Username (for various services)
false

SonarrImportList.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
id integer Sonarr Import List ID

Format: int32
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrImportList.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrIndexer

↩ Parent

Auto-generated derived type for SonarrIndexerSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrIndexer true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrIndexer represents an indexer configuration in Sonarr Indexers are sources for finding releases (Newznab, Torznab, etc.)
true
status object
false

SonarrIndexer.spec

↩ Parent

SonarrIndexer represents an indexer configuration in Sonarr Indexers are sources for finding releases (Newznab, Torznab, etc.)

Name Type Description Required
config object Indexer-specific configuration
true
indexerType enum Indexer type (Newznab, Torznab, etc.)

Enum: newznab, torznab, fanzub, broadcasthenet, filelist, hdbits, iptorrents, nyaa, torrentrss, torrentleech
true
name string Indexer name
true
sonarrInstanceRef object Reference to the SonarrInstance
true
downloadClientId integer Download client ID to use

Format: int32
false
enableAutomaticSearch boolean Enable automatic search

Default: true
false
enableInteractiveSearch boolean Enable interactive search

Default: true
false
enableRss boolean Enable RSS feeds

Default: true
false
priority integer Priority for this indexer

Format: int32
Default: 25
false
tags []integer Tags for this indexer

Default: []
false

SonarrIndexer.spec.config

↩ Parent

Indexer-specific configuration

Name Type Description Required
additionalParameters string Additional parameters
false
animeCategories []integer Anime categories

Default: []
false
animeStandardFormatSearch boolean Search anime in standard format

Default: false
false
apiKey string API key (can reference a secret)
false
apiKeySecretRef object API key from secret reference
false
apiPath string API path (default: /api)
false
baseUrl string Base URL for the indexer
false
categories []integer Categories to search

Default: []
false
cookie string Cookie (for some indexers)
false
minimumSeeders integer Minimum seeders (for torrent indexers)

Format: int32
false
passkey string Passkey (for some indexers)
false
passwordSecretRef object Password secret reference (for some indexers)
false
seedRatio number Seed ratio (for torrent indexers)

Format: double
false
seedTime integer Seed time (for torrent indexers)

Format: int32
false
username string Username (for some indexers)
false

SonarrIndexer.spec.config.apiKeySecretRef

↩ Parent

API key from secret reference

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

SonarrIndexer.spec.config.passwordSecretRef

↩ Parent

Password secret reference (for some indexers)

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

SonarrIndexer.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrIndexer.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
id integer Sonarr Indexer ID

Format: int32
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrIndexer.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrIndexerConfig

↩ Parent

Auto-generated derived type for SonarrIndexerConfigSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrIndexerConfig true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrIndexerConfig configures global indexer settings for a Sonarr instance. Only one SonarrIndexerConfig per Sonarr instance is allowed. Note: This is different from SonarrIndexer which configures individual indexers.
true
status object
false

SonarrIndexerConfig.spec

↩ Parent

SonarrIndexerConfig configures global indexer settings for a Sonarr instance. Only one SonarrIndexerConfig per Sonarr instance is allowed. Note: This is different from SonarrIndexer which configures individual indexers.

Name Type Description Required
sonarrInstanceRef object Reference to the Sonarr instance
true
maximumSize integer Maximum release size in MB (0 = unlimited)

Format: int32
false
minimumAge integer Minimum age in minutes before downloading (usenet)

Format: int32
false
retention integer Retention in days (0 = unlimited)

Format: int32
false
rssSyncInterval integer RSS sync interval in minutes (0 = disabled, minimum 10)

Format: int32
false

SonarrIndexerConfig.spec.sonarrInstanceRef

↩ Parent

Reference to the Sonarr instance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrIndexerConfig.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrIndexerConfig.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrLanguageProfile

↩ Parent

Auto-generated derived type for SonarrLanguageProfileSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrLanguageProfile true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrLanguageProfile represents a language profile configuration in Sonarr Language profiles define preferred languages for downloading series Note: Deprecated in Sonarr v4, replaced by per-series language selection
true
status object
false

SonarrLanguageProfile.spec

↩ Parent

SonarrLanguageProfile represents a language profile configuration in Sonarr Language profiles define preferred languages for downloading series Note: Deprecated in Sonarr v4, replaced by per-series language selection

Name Type Description Required
cutoffLanguage enum Cutoff language - stop upgrading when this language is reached

Enum: Unknown, English, French, Spanish, German, Italian, Danish, Dutch, Japanese, Icelandic, Chinese, Russian, Polish, Vietnamese, Swedish, Norwegian, Finnish, Turkish, Portuguese, Flemish, Greek, Korean, Hungarian, Hebrew, Lithuanian, Czech, Hindi, Romanian, Thai, Bulgarian, PortugueseBrazil, Arabic, Ukrainian, Persian, Bengali, Slovak, Latvian, SpanishLatino, Catalan, Croatian, Serbian, Bosnian, Estonian, Tamil, Indonesian, Telugu, Macedonian, Slovenian, Malay, Original, Any
true
languages []object Ordered list of languages (first = highest priority)
true
name string Language profile name
true
sonarrInstanceRef object Reference to the SonarrInstance
true
upgradeAllowed boolean Allow upgrades to better quality languages

Default: false
false

SonarrLanguageProfile.spec.languages[index]

↩ Parent

Name Type Description Required
language enum Language

Enum: Unknown, English, French, Spanish, German, Italian, Danish, Dutch, Japanese, Icelandic, Chinese, Russian, Polish, Vietnamese, Swedish, Norwegian, Finnish, Turkish, Portuguese, Flemish, Greek, Korean, Hungarian, Hebrew, Lithuanian, Czech, Hindi, Romanian, Thai, Bulgarian, PortugueseBrazil, Arabic, Ukrainian, Persian, Bengali, Slovak, Latvian, SpanishLatino, Catalan, Croatian, Serbian, Bosnian, Estonian, Tamil, Indonesian, Telugu, Macedonian, Slovenian, Malay, Original, Any
true
allowed boolean Whether this language is allowed

Default: true
false

SonarrLanguageProfile.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrLanguageProfile.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
id integer Sonarr Language Profile ID

Format: int32
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrLanguageProfile.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrMediaManagementConfig

↩ Parent

Auto-generated derived type for SonarrMediaManagementConfigSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrMediaManagementConfig true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrMediaManagementConfig configures media management settings for a Sonarr instance. Only one SonarrMediaManagementConfig per Sonarr instance is allowed.
true
status object
false

SonarrMediaManagementConfig.spec

↩ Parent

SonarrMediaManagementConfig configures media management settings for a Sonarr instance. Only one SonarrMediaManagementConfig per Sonarr instance is allowed.

Name Type Description Required
sonarrInstanceRef object Reference to the Sonarr instance
true
autoUnmonitorPreviouslyDownloadedEpisodes boolean Auto unmonitor previously downloaded episodes when marked as deleted
false
chmodFolder string chmod folder permissions (e.g., "755")
false
chownGroup string chown group
false
copyUsingHardlinks boolean Use hardlinks instead of copy when possible
false
createEmptySeriesFolders boolean Create empty series folders during disk scan
false
deleteEmptyFolders boolean Delete empty series and season folders during disk scan
false
downloadPropersAndRepacks enum Download propers and repacks: DoNotPrefer, PreferAndUpgrade, DoNotUpgrade

Enum: DoNotPrefer, PreferAndUpgrade, DoNotUpgrade
false
enableMediaInfo boolean Enable media info scanning
false
episodeTitleRequired enum Episode title required: Always, BulkSeasonReleases, Never

Enum: Always, BulkSeasonReleases, Never
false
extraFileExtensions string Extra file extensions to import (e.g., "srt,sub")
false
fileDate enum File date to use: None, LocalAirDate, UtcAirDate

Enum: None, LocalAirDate, UtcAirDate
false
importExtraFiles boolean Import extra files (subtitles, etc.)
false
minimumFreeSpaceWhenImporting integer Minimum free space when importing (MB)

Format: int32
false
recycleBin string Recycle bin path (empty to disable)
false
recycleBinCleanupDays integer Days to keep files in recycle bin before cleaning (0 to disable)

Format: int32
false
rescanAfterRefresh enum Rescan series folder after refresh: Always, AfterManual, Never

Enum: Always, AfterManual, Never
false
scriptImportPath string Script import path
false
setPermissionsLinux boolean Set permissions on Linux/macOS
false
skipFreeSpaceCheckWhenImporting boolean Skip free space check when importing
false
useScriptImport boolean Use script for importing
false

SonarrMediaManagementConfig.spec.sonarrInstanceRef

↩ Parent

Reference to the Sonarr instance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrMediaManagementConfig.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrMediaManagementConfig.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrMetadata

↩ Parent

Auto-generated derived type for SonarrMetadataSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrMetadata true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrMetadata represents a metadata consumer configuration in Sonarr Metadata consumers write metadata files for media managers (Kodi, Plex, etc.)
true
status object
false

SonarrMetadata.spec

↩ Parent

SonarrMetadata represents a metadata consumer configuration in Sonarr Metadata consumers write metadata files for media managers (Kodi, Plex, etc.)

Name Type Description Required
metadataType enum Metadata type/implementation

Enum: xbmcMetadata, roksboxMetadata, wdtvMetadata
true
name string Metadata consumer name
true
sonarrInstanceRef object Reference to the SonarrInstance
true
config object Metadata-specific configuration

Default: map[episodeImages:false episodeMetadata:false seasonImages:false seriesImages:false seriesMetadata:false seriesMetadataUrl:false]
false
enable boolean Enable this metadata consumer

Default: true
false
tags []integer Tags for this metadata consumer

Default: []
false

SonarrMetadata.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrMetadata.spec.config

↩ Parent

Metadata-specific configuration

Name Type Description Required
episodeImages boolean Write episode images (thumbnails)

Default: false
false
episodeMetadata boolean Write episode metadata (episode.nfo)

Default: true
false
seasonImages boolean Write season images

Default: true
false
seriesImages boolean Write series images (poster, banner, fanart)

Default: true
false
seriesMetadata boolean Write series metadata (series.nfo)

Default: true
false
seriesMetadataUrl boolean Write series metadata URL (deprecated)

Default: false
false

SonarrMetadata.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
id integer Sonarr Metadata ID

Format: int32
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrMetadata.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrNamingConfig

↩ Parent

Auto-generated derived type for SonarrNamingConfigSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrNamingConfig true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrNamingConfig configures episode naming settings for a Sonarr instance. Only one SonarrNamingConfig per Sonarr instance is allowed.
true
status object
false

SonarrNamingConfig.spec

↩ Parent

SonarrNamingConfig configures episode naming settings for a Sonarr instance. Only one SonarrNamingConfig per Sonarr instance is allowed.

Name Type Description Required
sonarrInstanceRef object Reference to the Sonarr instance
true
animeEpisodeFormat string Anime episode format Example: "{Series Title} - S{season:00}E{episode:00} - {Episode Title} {Quality Full}"
false
colonReplacementFormat integer Colon replacement format (0=Delete, 1=Dash, 2=SpaceDash, 3=SpaceDashSpace, 4=Smart)

Format: int32
false
customColonReplacementFormat string Custom colon replacement format string
false
dailyEpisodeFormat string Daily episode format Example: "{Series Title} - {Air-Date} - {Episode Title} {Quality Full}"
false
multiEpisodeStyle integer Multi-episode style (0=Extend, 1=Duplicate, 2=Repeat, 3=Scene, 4=Range, 5=PrefixedRange)

Format: int32
false
renameEpisodes boolean Enable episode renaming
false
replaceIllegalCharacters boolean Replace illegal characters in filenames
false
seasonFolderFormat string Season folder format Example: "Season {season}"
false
seriesFolderFormat string Series folder format Example: "{Series Title}"
false
specialsFolderFormat string Specials folder format Example: "Specials"
false
standardEpisodeFormat string Standard episode format Example: "{Series Title} - S{season:00}E{episode:00} - {Episode Title} {Quality Full}"
false

SonarrNamingConfig.spec.sonarrInstanceRef

↩ Parent

Reference to the Sonarr instance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrNamingConfig.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrNamingConfig.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrNotification

↩ Parent

Auto-generated derived type for SonarrNotificationSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrNotification true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrNotification represents a notification/connect configuration in Sonarr Notifications are used to alert on events (Discord, Telegram, Webhook, etc.)
true
status object
false

SonarrNotification.spec

↩ Parent

SonarrNotification represents a notification/connect configuration in Sonarr Notifications are used to alert on events (Discord, Telegram, Webhook, etc.)

Name Type Description Required
config object Notification configuration
true
name string Notification name
true
notificationType enum Notification type

Enum: Apprise, CustomScript, Discord, Email, Emby, Gotify, Join, Kodi, Mailgun, Ntfy, Plex, Prowl, Pushbullet, Pushover, SendGrid, Signal, Simplepush, Slack, SynologyIndexer, Telegram, Trakt, Twitter, Webhook
true
sonarrInstanceRef object Reference to the SonarrInstance
true
tags []integer Tags for this notification

Default: []
false
triggers object Event triggers

Default: map[includeHealthWarnings:false onApplicationUpdate:false onDownload:false onEpisodeFileDelete:false onEpisodeFileDeleteForUpgrade:false onGrab:false onHealthIssue:false onHealthRestored:false onImportComplete:false onManualInteractionRequired:false onRename:false onSeriesAdd:false onSeriesDelete:false onUpgrade:false]
false

SonarrNotification.spec.config

↩ Parent

Notification configuration

Name Type Description Required
apiKeySecretRef object API key secret reference
false
appTokenSecretRef object Gotify app token secret reference
false
arguments string Script arguments
false
authTokenSecretRef object Auth token secret reference
false
avatar string Discord avatar
false
bcc []string BCC addresses

Default: []
false
botTokenSecretRef object Telegram bot token secret reference
false
cc []string CC addresses

Default: []
false
channel string Slack channel
false
chatId string Telegram chat ID
false
clickUrl string Click URL
false
devices []string Device list

Default: []
false
discordUsername string Discord username
false
expire integer Expire after (seconds)

Format: int32
false
from string From address
false
host string Server host
false
icon string Slack icon
false
mapTo string Notify on specific library sections
false
method integer HTTP Method (1 = POST, 2 = PUT)

Format: int32
false
ntfyTags []string Ntfy tags

Default: []
false
passwordSecretRef object Password secret reference
false
path string Path to script
false
port integer SMTP port

Format: int32
false
priority integer Priority level

Format: int32
false
requireEncryption boolean Require encryption

Default: false
false
retry integer Retry interval (seconds)

Format: int32
false
sendSilently boolean Send silently

Default: false
false
server string SMTP server
false
serverUrl string Ntfy server URL
false
slackWebhookUrl string Slack webhook URL
false
sound string Sound
false
to []string To addresses

Default: []
false
topic string Ntfy topic
false
updateLibrary boolean Update library

Default: false
false
url string Webhook URL
false
useSsl boolean Use SSL

Default: false
false
userKeySecretRef object User key secret reference
false
username string Username for basic auth
false
webhookUrl string Discord webhook URL
false

SonarrNotification.spec.config.apiKeySecretRef

↩ Parent

API key secret reference

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

SonarrNotification.spec.config.appTokenSecretRef

↩ Parent

Gotify app token secret reference

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

SonarrNotification.spec.config.authTokenSecretRef

↩ Parent

Auth token secret reference

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

SonarrNotification.spec.config.botTokenSecretRef

↩ Parent

Telegram bot token secret reference

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

SonarrNotification.spec.config.passwordSecretRef

↩ Parent

Password secret reference

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

SonarrNotification.spec.config.userKeySecretRef

↩ Parent

User key secret reference

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

SonarrNotification.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrNotification.spec.triggers

↩ Parent

Event triggers

Name Type Description Required
includeHealthWarnings boolean Include health warnings

Default: false
false
onApplicationUpdate boolean On application update

Default: false
false
onDownload boolean On download (episode is downloaded)

Default: false
false
onEpisodeFileDelete boolean On episode file delete

Default: false
false
onEpisodeFileDeleteForUpgrade boolean On episode file delete for upgrade

Default: false
false
onGrab boolean On grab (episode is grabbed)

Default: false
false
onHealthIssue boolean On health issue

Default: false
false
onHealthRestored boolean On health restored

Default: false
false
onImportComplete boolean On import complete

Default: false
false
onManualInteractionRequired boolean On manual interaction required

Default: false
false
onRename boolean On rename

Default: false
false
onSeriesAdd boolean On series add

Default: false
false
onSeriesDelete boolean On series delete

Default: false
false
onUpgrade boolean On upgrade (episode is upgraded)

Default: false
false

SonarrNotification.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
id integer Sonarr Notification ID

Format: int32
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrNotification.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrQualityDefinition

↩ Parent

Auto-generated derived type for SonarrQualityDefinitionSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrQualityDefinition true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrQualityDefinition represents a quality definition configuration in Sonarr Quality definitions control the size limits for each quality level
true
status object
false

SonarrQualityDefinition.spec

↩ Parent

SonarrQualityDefinition represents a quality definition configuration in Sonarr Quality definitions control the size limits for each quality level

Name Type Description Required
qualityName enum Quality name (must match existing quality in Sonarr)

Enum: UNKNOWN, SDTV, DVD, WEBDL-480p, WEBRip-480p, Bluray-480p, HDTV-720p, HDTV-1080p, Raw-HD, WEBDL-720p, WEBRip-720p, Bluray-720p, WEBDL-1080p, WEBRip-1080p, Bluray-1080p, Bluray-1080p Remux, HDTV-2160p, WEBDL-2160p, WEBRip-2160p, Bluray-2160p, Bluray-2160p Remux
true
sonarrInstanceRef object Reference to the SonarrInstance
true
maxSize number Maximum size in MB per minute of runtime (None = unlimited)

Format: double
false
minSize number Minimum size in MB per minute of runtime

Format: double
false
preferredSize number Preferred size in MB per minute of runtime

Format: double
false
title string Title/display name for this quality
false

SonarrQualityDefinition.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrQualityDefinition.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
id integer Sonarr Quality Definition ID

Format: int32
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrQualityDefinition.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrQualityProfile

↩ Parent

Auto-generated derived type for SonarrQualityProfileSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrQualityProfile true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrQualityProfile represents a quality profile in Sonarr Quality profiles define which qualities are acceptable and their priority
true
status object
false

SonarrQualityProfile.spec

↩ Parent

SonarrQualityProfile represents a quality profile in Sonarr Quality profiles define which qualities are acceptable and their priority

Name Type Description Required
name string Quality profile name
true
qualityGroups []object Ordered list of quality groups
true
sonarrInstanceRef object Reference to the SonarrInstance
true
cutoff integer Quality ID to use as cutoff

Format: int32
Default: 0
false
cutoffFormatScore integer Cutoff format score

Format: int32
false
formatItems []object Format items (custom formats with scores)

Default: []
false
minFormatScore integer Minimum format score

Format: int32
false
minUpgradeFormatScore integer Minimum upgrade format score

Format: int32
false
upgradeAllowed boolean Whether upgrades are allowed

Default: false
false

SonarrQualityProfile.spec.qualityGroups[index]

↩ Parent

Name Type Description Required
qualities []object Ordered list of qualities in this group
true
id integer Quality group ID

Format: int32
false
name string Quality group name
false

SonarrQualityProfile.spec.qualityGroups[index].qualities[index]

↩ Parent

Name Type Description Required
id integer Quality ID

Format: int32
false
name string Quality name
false
resolution integer Resolution

Format: int32
false
source string Source type
false

SonarrQualityProfile.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrQualityProfile.spec.formatItems[index]

↩ Parent

Name Type Description Required
format integer Custom format ID

Format: int32
false
name string Format name
false
score integer Score for this format

Format: int32
Default: 0
false

SonarrQualityProfile.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
id integer Sonarr Quality Profile ID

Format: int32
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrQualityProfile.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrRootFolder

↩ Parent

Auto-generated derived type for SonarrRootFolderSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrRootFolder true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrRootFolder represents a root folder in Sonarr Root folders are the base directories where series are stored
true
status object
false

SonarrRootFolder.spec

↩ Parent

SonarrRootFolder represents a root folder in Sonarr Root folders are the base directories where series are stored

Name Type Description Required
path string Root folder absolute path
true
sonarrInstanceRef object Reference to the SonarrInstance
true

SonarrRootFolder.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrRootFolder.status

↩ Parent

Name Type Description Required
accessible boolean Whether the folder is accessible
false
conditions []object Current conditions

Default: []
false
freeSpace integer Free space in the folder

Format: int64
false
id integer Sonarr Root Folder ID

Format: int32
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrRootFolder.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrSeries

↩ Parent

Auto-generated derived type for SonarrSeriesSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrSeries true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrSeries represents a TV series managed in Sonarr This allows declarative management of series in your library
true
status object
false

SonarrSeries.spec

↩ Parent

SonarrSeries represents a TV series managed in Sonarr This allows declarative management of series in your library

Name Type Description Required
qualityProfile object Quality profile ID or name reference
true
rootFolderPath string Root folder path for the series
true
sonarrInstanceRef object Reference to the SonarrInstance
true
title string Series title
true
titleSlug string Title slug (kebab-case version of title)
true
tvdbId integer TVDB ID for the series

Format: int32
true
addOptions object Monitor type for adding series

Default: map[monitor:all searchForCutoffUnmetEpisodes:false searchForMissingEpisodes:true]
false
monitored boolean Whether the series is monitored

Default: true
false
path string Specific path override (optional)
false
seasonFolder boolean Use season folders

Default: true
false
seriesType enum Series type

Enum: standard, daily, anime
Default: standard
false
tags []integer Tags for this series

Default: []
false
useSceneNumbering boolean Use scene numbering

Default: false
false

SonarrSeries.spec.qualityProfile

↩ Parent

Quality profile ID or name reference

Name Type Description Required
id integer Quality profile ID

Format: int32
false
name string Quality profile name (will be resolved to ID)
false

SonarrSeries.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrSeries.spec.addOptions

↩ Parent

Monitor type for adding series

Name Type Description Required
monitor enum Monitor type

Enum: all, future, missing, existing, recent, pilot, firstseason, lastseason, none
Default: all
false
searchForCutoffUnmetEpisodes boolean Search for cutoff unmet episodes

Default: false
false
searchForMissingEpisodes boolean Search for missing episodes when adding

Default: true
false

SonarrSeries.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
episodeCount integer Total episode count

Format: int32
false
episodeFileCount integer Episode file count

Format: int32
false
id integer Sonarr Series ID

Format: int32
false
network string Network
false
nextAiring string Next airing date
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false
percentComplete number Percentage complete

Format: double
false
previousAiring string Previous airing date
false
seriesStatus string Status (continuing, ended, etc.)
false

SonarrSeries.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

Sonarr

↩ Parent

Auto-generated derived type for SonarrSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string Sonarr true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object Sonarr is the main CRD that deploys and manages a Sonarr instance

This CRD creates:

  • A Deployment with the Sonarr container
  • An init container for database migrations
  • A Service to expose Sonarr
  • A PersistentVolumeClaim for configuration storage
  • Optional Ingress for external access
true
status object
false

Sonarr.spec

↩ Parent

Sonarr is the main CRD that deploys and manages a Sonarr instance

This CRD creates:

  • A Deployment with the Sonarr container
  • An init container for database migrations
  • A Service to expose Sonarr
  • A PersistentVolumeClaim for configuration storage
  • Optional Ingress for external access
Name Type Description Required
apiKeySecretRef object API key secret reference (optional - will be auto-generated if not provided)
false
config object Sonarr application configuration (config.xml settings)

Default: map[analyticsEnabled: authenticationMethod: authenticationRequired: bindAddress: initContainerImage: instanceName: logLevel: urlBase:]
false
env []object Environment variables

Default: []
false
httpRoute object HTTPRoute configuration for Gateway API (optional)
false
image string Sonarr image to use (default: lscr.io/linuxserver/sonarr:latest)

Default: lscr.io/linuxserver/sonarr:latest
false
imagePullPolicy string Image pull policy (default: IfNotPresent)

Default: IfNotPresent
false
ingress object Ingress configuration (optional)
false
initContainer object Init container configuration (for custom init logic)
false
nodeSelector map[string]string Node selector

Default: map[]
false
replicas integer Number of replicas (should be 1 for Sonarr)

Format: int32
Default: 1
false
resources object Resource requirements
false
securityContext object Pod security context
false
service object Service configuration

Default: map[annotations:map[] containerPort:0 nodePort: port:0 serviceType:]
false
storage object Storage configuration

Default: map[accessModes:[] existingClaim: size: storageClass:]
false
tolerations []object Tolerations

Default: []
false
volumeMounts []object Volume mounts for media directories

Default: []
false
volumes []object Additional volumes

Default: []
false

Sonarr.spec.apiKeySecretRef

↩ Parent

API key secret reference (optional - will be auto-generated if not provided)

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

Sonarr.spec.config

↩ Parent

Sonarr application configuration (config.xml settings)

Name Type Description Required
analyticsEnabled boolean Analytics enabled (default: true)
false
authenticationMethod string Authentication method: None, Basic, Forms, External (default: None)
false
authenticationRequired boolean Authentication required for API access (default: false)
false
bindAddress string Bind address (default: "*")
false
initContainerImage string Init container image used to configure config.xml (default: busybox:latest)
false
instanceName string Instance name displayed in the UI
false
logLevel string Log level: trace, debug, info, warn, error (default: info)
false
urlBase string URL base for reverse proxy setups (e.g., "/sonarr")
false

Sonarr.spec.env[index]

↩ Parent

Name Type Description Required
name string Name of the environment variable
true
value string Value of the environment variable
false
valueFrom object Reference to a secret or configmap
false

Sonarr.spec.env[index].valueFrom

↩ Parent

Reference to a secret or configmap

Name Type Description Required
configMapKeyRef object ConfigMap key reference
false
secretKeyRef object Secret key reference
false

Sonarr.spec.env[index].valueFrom.configMapKeyRef

↩ Parent

ConfigMap key reference

Name Type Description Required
key string Key in the configmap
true
name string Name of the configmap
true

Sonarr.spec.env[index].valueFrom.secretKeyRef

↩ Parent

Secret key reference

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

Sonarr.spec.httpRoute

↩ Parent

HTTPRoute configuration for Gateway API (optional)

Name Type Description Required
gatewayRef object Gateway reference - the Gateway to attach to
true
annotations map[string]string Additional annotations for the HTTPRoute

Default: map[]
false
enabled boolean Enable HTTPRoute creation (default: false)

Default: false
false
hostnames []string Hostnames for the HTTPRoute

Default: []
false
labels map[string]string Additional labels for the HTTPRoute

Default: map[]
false
path string Path match for the route (default: /)

Default: /
false
pathType string Path match type: Exact, PathPrefix, or RegularExpression (default: PathPrefix)

Default: PathPrefix
false

Sonarr.spec.httpRoute.gatewayRef

↩ Parent

Gateway reference - the Gateway to attach to

Name Type Description Required
name string Name of the Gateway
true
namespace string Namespace of the Gateway (optional, defaults to same namespace as HTTPRoute)
false
sectionName string Section name within the Gateway (optional)
false

Sonarr.spec.ingress

↩ Parent

Ingress configuration (optional)

Name Type Description Required
host string Hostname for the ingress
true
annotations map[string]string Ingress annotations

Default: map[]
false
enabled boolean Enable ingress (default: false)

Default: false
false
ingressClassName string Ingress class name
false
path string Path for the ingress (default: /)

Default: /
false
pathType string Path type (default: Prefix)

Default: Prefix
false
tls object TLS configuration
false

Sonarr.spec.ingress.tls

↩ Parent

TLS configuration

Name Type Description Required
secretName string Secret name containing TLS certificate
true
hosts []string Hosts covered by the TLS certificate

Default: []
false

Sonarr.spec.initContainer

↩ Parent

Init container configuration (for custom init logic)

Name Type Description Required
args []string Arguments for the command

Default: []
false
command []string Command to run in init container

Default: []
false
env []object Environment variables for init container

Default: []
false
image string Image for init container (default: busybox:latest)

Default: busybox:latest
false

Sonarr.spec.initContainer.env[index]

↩ Parent

Name Type Description Required
name string Name of the environment variable
true
value string Value of the environment variable
false
valueFrom object Reference to a secret or configmap
false

Sonarr.spec.initContainer.env[index].valueFrom

↩ Parent

Reference to a secret or configmap

Name Type Description Required
configMapKeyRef object ConfigMap key reference
false
secretKeyRef object Secret key reference
false

Sonarr.spec.initContainer.env[index].valueFrom.configMapKeyRef

↩ Parent

ConfigMap key reference

Name Type Description Required
key string Key in the configmap
true
name string Name of the configmap
true

Sonarr.spec.initContainer.env[index].valueFrom.secretKeyRef

↩ Parent

Secret key reference

Name Type Description Required
key string Key in the secret
true
name string Name of the secret
true

Sonarr.spec.resources

↩ Parent

Resource requirements

Name Type Description Required
limits map[string]string Resource limits

Default: map[]
false
requests map[string]string Resource requests

Default: map[]
false

Sonarr.spec.securityContext

↩ Parent

Pod security context

Name Type Description Required
fsGroup integer

Format: int64
false
runAsGroup integer

Format: int64
false
runAsNonRoot boolean
false
runAsUser integer

Format: int64
false

Sonarr.spec.service

↩ Parent

Service configuration

Name Type Description Required
annotations map[string]string Service annotations

Default: map[]
false
containerPort integer Container port - the port Sonarr listens on inside the container (default: 8989)

Format: int32
Default: 8989
false
nodePort integer Node port (only for NodePort type)

Format: int32
false
port integer Service port (default: 8989)

Format: int32
Default: 8989
false
serviceType string Service type (default: ClusterIP)

Default: ClusterIP
false

Sonarr.spec.storage

↩ Parent

Storage configuration

Name Type Description Required
accessModes []string Access modes (default: ReadWriteOnce)

Default: [ReadWriteOnce]
false
existingClaim string Existing PVC to use (optional)
false
size string Size of the config PVC (default: 1Gi)

Default: 1Gi
false
storageClass string Storage class for the PVC
false

Sonarr.spec.tolerations[index]

↩ Parent

Name Type Description Required
effect string
false
key string
false
operator string
false
tolerationSeconds integer

Format: int64
false
value string
false

Sonarr.spec.volumeMounts[index]

↩ Parent

Name Type Description Required
mountPath string Mount path inside the container
true
name string Name of the volume
true
readOnly boolean Read only flag

Default: false
false
subPath string Sub path (optional)
false

Sonarr.spec.volumes[index]

↩ Parent

Name Type Description Required
name string Name of the volume
true
configMap object ConfigMap volume
false
emptyDir object Empty dir volume
false
hostPath object HostPath volume
false
nfs object NFS volume
false
persistentVolumeClaim object PVC claim
false

Sonarr.spec.volumes[index].configMap

↩ Parent

ConfigMap volume

Name Type Description Required
name string
true
items []object

Default: []
false

Sonarr.spec.volumes[index].configMap.items[index]

↩ Parent

Name Type Description Required
key string
true
path string
true

Sonarr.spec.volumes[index].emptyDir

↩ Parent

Empty dir volume

Name Type Description Required
medium string
false
sizeLimit string
false

Sonarr.spec.volumes[index].hostPath

↩ Parent

HostPath volume

Name Type Description Required
path string
true
type string
false

Sonarr.spec.volumes[index].nfs

↩ Parent

NFS volume

Name Type Description Required
path string
true
server string
true
readOnly boolean

Default: false
false

Sonarr.spec.volumes[index].persistentVolumeClaim

↩ Parent

PVC claim

Name Type Description Required
claimName string
true
readOnly boolean

Default: false
false

Sonarr.status

↩ Parent

Name Type Description Required
apiKeySecret string API key (stored in secret)
false
conditions []object Current conditions

Default: []
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false
readyReplicas integer Number of ready replicas

Format: int32
Default: 0
false
url string URL to access Sonarr
false
version string Sonarr version
false

Sonarr.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false

SonarrTag

↩ Parent

Auto-generated derived type for SonarrTagSpec via CustomResource

Name Type Description Required
apiVersion string devopsarr.io/v1alpha1 true
kind string SonarrTag true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object SonarrTag represents a tag in Sonarr Tags are used to organize and filter series, profiles, and other resources
true
status object
false

SonarrTag.spec

↩ Parent

SonarrTag represents a tag in Sonarr Tags are used to organize and filter series, profiles, and other resources

Name Type Description Required
label string Tag label (must be lowercase)
true
sonarrInstanceRef object Reference to the SonarrInstance
true

SonarrTag.spec.sonarrInstanceRef

↩ Parent

Reference to the SonarrInstance

Name Type Description Required
name string Name of the SonarrInstance resource

Default:
false
namespace string Namespace of the SonarrInstance (optional, defaults to same namespace)
false

SonarrTag.status

↩ Parent

Name Type Description Required
conditions []object Current conditions

Default: []
false
id integer Sonarr Tag ID

Format: int32
false
observedGeneration integer Observed generation

Format: int64
Default: 0
false

SonarrTag.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
message string message is a human readable message indicating details about the transition. This may be an empty string.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
status string status of the condition, one of True, False, Unknown.
true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
false