SonarQube Operator API
Packages:
edp.epam.com/v1alpha1
Resource Types:
SonarGroupβ
β© ParentSonarGroup is the Schema for the sonar group API.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | edp.epam.com/v1alpha1 | true |
kind | string | SonarGroup | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
spec | object | SonarGroupSpec defines the desired state of SonarGroup. | false |
status | object | SonarGroupStatus defines the observed state of SonarGroup. | false |
SonarGroup.specβ
β© ParentSonarGroupSpec defines the desired state of SonarGroup.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name is a group name.
Name should be unique across all groups.
Do not edit this field after creation. Otherwise, the group will be recreated. | true |
sonarRef | object | SonarRef is a reference to Sonar custom resource. | true |
description | string | Description of sonar group. | false |
permissions | []string | Permissions is a list of permissions assigned to group. | false |
SonarGroup.spec.sonarRefβ
β© ParentSonarRef is a reference to Sonar custom resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name specifies the name of the Sonar resource. | true |
kind | string | Kind specifies the kind of the Sonar resource. Default: Sonar | false |
SonarGroup.statusβ
β© ParentSonarGroupStatus defines the observed state of SonarGroup.
Name | Type | Description | Required |
---|---|---|---|
error | string | Error is an error message if something went wrong. | false |
value | string | Value is a status of the group. | false |
SonarPermissionTemplateβ
β© ParentSonarPermissionTemplate is the Schema for the sonar permission template API.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | edp.epam.com/v1alpha1 | true |
kind | string | SonarPermissionTemplate | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
spec | object | SonarPermissionTemplateSpec defines the desired state of SonarPermissionTemplate. | false |
status | object | SonarPermissionTemplateStatus defines the observed state of SonarPermissionTemplate. | false |
SonarPermissionTemplate.specβ
β© ParentSonarPermissionTemplateSpec defines the desired state of SonarPermissionTemplate.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name is a name of permission template.
Name should be unique across all permission templates.
Do not edit this field after creation. Otherwise, the permission template will be recreated. | true |
sonarRef | object | SonarRef is a reference to Sonar custom resource. | true |
default | boolean | Default is a flag to set permission template as default.
Only one permission template can be default.
If several permission templates have default flag, the random one will be chosen.
Default permission template can't be deleted. You need to set another permission template as default before. | false |
description | string | Description of sonar permission template. | false |
groupsPermissions | map[string][]string | GroupsPermissions is a map of groups and permissions assigned to them. | false |
projectKeyPattern | string | ProjectKeyPattern is key pattern. Must be a valid Java regular expression. | false |
SonarPermissionTemplate.spec.sonarRefβ
β© ParentSonarRef is a reference to Sonar custom resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name specifies the name of the Sonar resource. | true |
kind | string | Kind specifies the kind of the Sonar resource. Default: Sonar | false |
SonarPermissionTemplate.statusβ
β© ParentSonarPermissionTemplateStatus defines the observed state of SonarPermissionTemplate.
Name | Type | Description | Required |
---|---|---|---|
error | string | Error is an error message if something went wrong. | false |
value | string | Value is a status of the permission template. | false |
SonarQualityGateβ
β© ParentSonarQualityGate is the Schema for the sonarqualitygates API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | edp.epam.com/v1alpha1 | true |
kind | string | SonarQualityGate | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
spec | object | SonarQualityGateSpec defines the desired state of SonarQualityGate | false |
status | object | SonarQualityGateStatus defines the observed state of SonarQualityGate | false |
SonarQualityGate.specβ
β© ParentSonarQualityGateSpec defines the desired state of SonarQualityGate
Name | Type | Description | Required |
---|---|---|---|
name | string | Name is a name of quality gate.
Name should be unique across all quality gates.
Don't change this field after creation otherwise quality gate will be recreated. | true |
sonarRef | object | SonarRef is a reference to Sonar custom resource. | true |
conditions | map[string]object | Conditions is a list of conditions for quality gate.
Key is a metric name, value is a condition. | false |
default | boolean | Default is a flag to set quality gate as default.
Only one quality gate can be default.
If several quality gates have default flag, the random one will be chosen.
Default quality gate can't be deleted. You need to set another quality gate as default before. | false |
SonarQualityGate.spec.sonarRefβ
β© ParentSonarRef is a reference to Sonar custom resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name specifies the name of the Sonar resource. | true |
kind | string | Kind specifies the kind of the Sonar resource. Default: Sonar | false |
SonarQualityGate.spec.conditions[key]β
β© ParentCondition defines the condition for quality gate.
Name | Type | Description | Required |
---|---|---|---|
error | string | Error is condition error threshold. | true |
op | enum | Op is condition operator.
LT = is lower than
GT = is greater than Enum: LT, GT | false |
SonarQualityGate.statusβ
β© ParentSonarQualityGateStatus defines the observed state of SonarQualityGate
Name | Type | Description | Required |
---|---|---|---|
error | string | Error is an error message if something went wrong. | false |
value | string | Value is a status of the quality gate. | false |
SonarQualityProfileβ
β© ParentSonarQualityProfile is the Schema for the sonarqualityprofiles API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | edp.epam.com/v1alpha1 | true |
kind | string | SonarQualityProfile | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
spec | object | SonarQualityProfileSpec defines the desired state of SonarQualityProfile | false |
status | object | SonarQualityProfileStatus defines the observed state of SonarQualityProfile | false |
SonarQualityProfile.specβ
β© ParentSonarQualityProfileSpec defines the desired state of SonarQualityProfile
Name | Type | Description | Required |
---|---|---|---|
language | string | Language is a language of quality profile. | true |
name | string | Name is a name of quality profile.
Name should be unique across all quality profiles.
Don't change this field after creation otherwise quality profile will be recreated. | true |
sonarRef | object | SonarRef is a reference to Sonar custom resource. | true |
default | boolean | Default is a flag to set quality profile as default.
Only one quality profile can be default.
If several quality profiles have default flag, the random one will be chosen.
Default quality profile can't be deleted. You need to set another quality profile as default before. | false |
rules | map[string]object | Rules is a list of rules for quality profile.
Key is a rule key, value is a rule. | false |
SonarQualityProfile.spec.sonarRefβ
β© ParentSonarRef is a reference to Sonar custom resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name specifies the name of the Sonar resource. | true |
kind | string | Kind specifies the kind of the Sonar resource. Default: Sonar | false |
SonarQualityProfile.spec.rules[key]β
β© ParentRule defines a rule of quality profile.
Name | Type | Description | Required |
---|---|---|---|
params | string | Params is as semicolon list of key=value. | false |
severity | enum | Severity is a severity of rule. Enum: INFO, MINOR, MAJOR, CRITICAL, BLOCKER | false |
SonarQualityProfile.statusβ
β© ParentSonarQualityProfileStatus defines the observed state of SonarQualityProfile
Name | Type | Description | Required |
---|---|---|---|
error | string | Error is an error message if something went wrong. | false |
value | string | Value is a status of the quality profile. | false |
Sonarβ
β© ParentSonar is the Schema for the sonars API.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | edp.epam.com/v1alpha1 | true |
kind | string | Sonar | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
spec | object | SonarSpec defines the desired state of Sonar. | false |
status | object | SonarStatus defines the observed state of Sonar. | false |
Sonar.specβ
β© ParentSonarSpec defines the desired state of Sonar.
Name | Type | Description | Required |
---|---|---|---|
secret | string | Secret is the name of the k8s object Secret related to sonar.
Secret should contain a user field with a sonar username and a password field with a sonar password.
Pass the token in the user field and leave the password field empty for token authentication. | true |
url | string | Url is the url of sonar instance. | true |
defaultPermissionTemplate | string | DefaultPermissionTemplate is the name of the default permission template. | false |
settings | []object | Settings specify which settings should be configured. | false |
Sonar.spec.settings[index]β
β© ParentSonarSetting defines the setting of sonar.
Name | Type | Description | Required |
---|---|---|---|
key | string | Key is the key of the setting. | true |
fieldValues | map[string]string | Setting field values. To set several values, the parameter must be called once for each value. | false |
value | string | Value is the value of the setting. | false |
values | []string | Setting multi value. To set several values, the parameter must be called once for each value. | false |
Sonar.statusβ
β© ParentSonarStatus defines the observed state of Sonar.
Name | Type | Description | Required |
---|---|---|---|
connected | boolean | Connected shows if operator is connected to sonar. | false |
error | string | Error represents error message if something went wrong. | false |
processedSettings | string | ProcessedSettings shows which settings were processed.
It is used to compare the current settings with the settings that were processed
to unset the settings that are not in the current settings. | false |
value | string | Value is status of sonar instance.
Possible values:
GREEN: SonarQube is fully operational
YELLOW: SonarQube is usable, but it needs attention in order to be fully operational
RED: SonarQube is not operational | false |
SonarUserβ
β© ParentSonarUser is the Schema for the sonarusers API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | edp.epam.com/v1alpha1 | true |
kind | string | SonarUser | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
spec | object | SonarUserSpec defines the desired state of SonarUser | false |
status | object | SonarUserStatus defines the observed state of SonarUser | false |
SonarUser.specβ
β© ParentSonarUserSpec defines the desired state of SonarUser
Name | Type | Description | Required |
---|---|---|---|
login | string | Login is a user login.
Do not edit this field after creation. Otherwise, the user will be recreated. | true |
name | string | Name is a username. | true |
secret | string | Secret is the name of the secret with the user password.
It should contain a password field with a user password.
User password can't be updated. | true |
sonarRef | object | SonarRef is a reference to Sonar custom resource. | true |
string | Email is a user email. | false | |
groups | []string | Groups is a list of groups assigned to user. | false |
permissions | []string | Permissions is a list of permissions assigned to user. | false |
SonarUser.spec.sonarRefβ
β© ParentSonarRef is a reference to Sonar custom resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name specifies the name of the Sonar resource. | true |
kind | string | Kind specifies the kind of the Sonar resource. Default: Sonar | false |
SonarUser.statusβ
β© ParentSonarUserStatus defines the observed state of SonarUser
Name | Type | Description | Required |
---|---|---|---|
error | string | Error is an error message if something went wrong. | false |
value | string | Value is a status of the user. | false |