Documentation
¶
Index ¶
- Constants
- type ApiError
- type AppContainer
- type AppContainerResponse
- type AppDetailContainer
- type AppEnvironmentContainer
- type AppStageStatus
- type BulkCdDeployEvent
- type CiMaterialDTO
- type CiPipelineLastSucceededTime
- type ClusterInfo
- type Config
- type ConfigMapAndSecretJson
- type ConfigMapJson
- type ConfigMapRootJson
- type ConfigSecretJson
- type ConfigSecretMap
- type ConfigSecretRootJson
- type CreateVulnerabilityPolicyRequest
- type CreateVulnerabilityPolicyResponse
- type CvePolicy
- type DeletePolicyParams
- type DeleteVulnerabilityPolicyResponse
- type DeploymentConfigurationType
- type DeploymentDetailContainer
- type DeploymentDetailStat
- type DeploymentGroupDTO
- type Environment
- type Error
- type FetchPolicyParams
- type GetVulnerabilityPolicyResponse
- type GetVulnerabilityPolicyResult
- type GitOpsConfigDto
- type GitRepoRequestDto
- type IdVulnerabilityPolicyResult
- type InstanceDetail
- type JobCIPipeline
- type JobContainer
- type JobContainerResponse
- type JobListingContainer
- type LinkOuts
- type Notes
- type PodDetailStat
- type PolicyRequest
- type PolicyType
- type ReleaseStatusUpdateRequest
- type ResourceLevel
- type ResourceTreeAndNotesContainer
- type ResourceUsage
- type Response
- type Role
- type RoleData
- type RoleFilter
- type RoleGroup
- type SSOLoginDto
- type SeverityPolicy
- type TriggerEvent
- type TriggerView
- type UpdatePolicyParams
- type UpdateVulnerabilityPolicyResponse
- type UserInfo
- type UserRole
- type ValuesOverrideRequest
- type VulnerabilityAction
- type VulnerabilityPermission
- type VulnerabilityPolicy
- type WorkflowType
Constants ¶
const ( POLICY_DIRECT PolicyType = 1 POLICY_GROUP PolicyType = 1 SUPERADMIN = "role:super-admin___" APP_ACCESS_TYPE_HELM = "helm-app" USER_TYPE_API_TOKEN = "apiToken" CHART_GROUP_ENTITY = "chart-group" CLUSTER_ENTITIY = "cluster" )
const ( CD_WORKFLOW_TYPE_PRE WorkflowType = "PRE" CD_WORKFLOW_TYPE_POST WorkflowType = "POST" CD_WORKFLOW_TYPE_DEPLOY WorkflowType = "DEPLOY" CI_WORKFLOW_TYPE WorkflowType = "CI" WEBHOOK_WORKFLOW_TYPE WorkflowType = "WEBHOOK" DEPLOYMENT_CONFIG_TYPE_LAST_SAVED DeploymentConfigurationType = "LAST_SAVED_CONFIG" //latest trigger is not being used because this is being handled at FE and we anyhow identify latest trigger as //last deployed wfr which is also a specific trigger DEPLOYMENT_CONFIG_TYPE_LATEST_TRIGGER DeploymentConfigurationType = "LATEST_TRIGGER_CONFIG" DEPLOYMENT_CONFIG_TYPE_SPECIFIC_TRIGGER DeploymentConfigurationType = "SPECIFIC_TRIGGER_CONFIG" )
const (
NOCHARTEXIST string = "NOCHARTEXIST"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppContainer ¶
type AppContainer struct { AppId int `json:"appId"` AppName string `json:"appName"` ProjectId int `json:"projectId"` AppEnvironmentContainer []*AppEnvironmentContainer `json:"environments"` DefaultEnv AppEnvironmentContainer `json:"-"` }
type AppContainerResponse ¶
type AppContainerResponse struct { AppContainers []*AppContainer `json:"appContainers"` AppCount int `json:"appCount"` DeploymentGroupDTO DeploymentGroupDTO `json:"deploymentGroup,omitempty"` }
type AppDetailContainer ¶
type AppDetailContainer struct { DeploymentDetailContainer `json:",inline"` InstanceDetail []InstanceDetail `json:"instanceDetail"` //pod list with cpu, memory usage percent Environments []Environment `json:"otherEnvironment,omitempty"` LinkOuts []LinkOuts `json:"linkOuts,omitempty"` ResourceTree map[string]interface{} `json:"resourceTree,omitempty"` Notes string `json:"notes,omitempty"` }
type AppEnvironmentContainer ¶
type AppEnvironmentContainer struct { AppId int `json:"appId"` AppName string `json:"appName"` EnvironmentId int `json:"environmentId"` EnvironmentName string `json:"environmentName"` Namespace string `json:"namespace"` ClusterName string `json:"clusterName"` DeploymentCounter int `json:"deploymentCounter,omitempty"` InstanceCounter int `json:"instanceCounter,omitempty"` Status string `json:"status"` AppStatus string `json:"appStatus"` CdStageStatus *string `json:"cdStageStatus"` PreStageStatus *string `json:"preStageStatus"` PostStageStatus *string `json:"postStageStatus"` LastDeployedTime string `json:"lastDeployedTime,omitempty"` LastSuccessDeploymentDetail DeploymentDetailContainer `json:"-"` Default bool `json:"default"` Deleted bool `json:"deleted"` MaterialInfo json.RawMessage `json:"materialInfo,omitempty"` DataSource string `json:"dataSource,omitempty"` MaterialInfoJson string `json:"-"` PipelineId int `json:"-"` PipelineReleaseCounter int `json:"-"` CiArtifactId int `json:"ciArtifactId"` Active bool `json:"-"` TeamId int `json:"teamId"` TeamName string `json:"teamName"` Description string `json:"description" validate:"max=40"` TotalCount int `json:"-"` }
type AppStageStatus ¶
type BulkCdDeployEvent ¶ added in v0.6.16
type BulkCdDeployEvent struct { ValuesOverrideRequest *ValuesOverrideRequest `json:"valuesOverrideRequest"` UserId int32 `json:"userId"` }
type CiMaterialDTO ¶
type CiPipelineLastSucceededTime ¶ added in v0.6.15
type ClusterInfo ¶ added in v0.3.14
type Config ¶ added in v0.5.3
type Config struct {
IgnoreAuthCheck bool `env:"IGNORE_AUTOCOMPLETE_AUTH_CHECK" envDefault:"false"`
}
type ConfigMapAndSecretJson ¶
type ConfigMapAndSecretJson struct { ConfigMapJson ConfigMapJson `json:"configMapJson"` ConfigSecretJson ConfigSecretJson `json:"configSecretJson"` }
type ConfigMapJson ¶
type ConfigMapJson struct { Enabled bool `json:"enabled"` Maps []ConfigSecretMap `json:"maps"` }
type ConfigMapRootJson ¶
type ConfigMapRootJson struct {
ConfigMapJson ConfigMapJson `json:"ConfigMaps"`
}
type ConfigSecretJson ¶
type ConfigSecretJson struct { Enabled bool `json:"enabled"` Secrets []*ConfigSecretMap `json:"secrets"` }
type ConfigSecretMap ¶ added in v0.6.17
type ConfigSecretMap struct { Name string `json:"name"` Type string `json:"type"` External bool `json:"external"` MountPath string `json:"mountPath"` Data json.RawMessage `json:"data,omitempty"` ESOSecretData json.RawMessage `json:"esoSecretData,omitempty"` ExternalType string `json:"externalType"` RoleARN string `json:"roleARN"` SecretData json.RawMessage `json:"secretData,omitempty"` SubPath bool `json:"subPath"` FilePermission string `json:"filePermission"` }
func (ConfigSecretMap) GetDataMap ¶ added in v0.6.17
func (configSecret ConfigSecretMap) GetDataMap() (map[string]string, error)
type ConfigSecretRootJson ¶
type ConfigSecretRootJson struct {
ConfigSecretJson ConfigSecretJson `json:"ConfigSecrets"`
}
type CreateVulnerabilityPolicyRequest ¶
type CreateVulnerabilityPolicyRequest struct { // actions which can be taken on vulnerabilities Action *VulnerabilityAction `json:"action,omitempty"` AppId int `json:"appId,omitempty"` ClusterId int `json:"clusterId,omitempty"` CveId string `json:"cveId,omitempty"` EnvId int `json:"envId,omitempty"` Severity string `json:"severity,omitempty"` }
CreateVulnerabilityPolicyRequest defines model for CreateVulnerabilityPolicyRequest.
type CreateVulnerabilityPolicyResponse ¶
type CreateVulnerabilityPolicyResponse struct { // Error object Error *Error `json:"error,omitempty"` Result *IdVulnerabilityPolicyResult `json:"result,omitempty"` }
CreateVulnerabilityPolicyResponse defines model for CreateVulnerabilityPolicyResponse.
type CvePolicy ¶
type CvePolicy struct { // Embedded struct due to allOf(#/components/schemas/SeverityPolicy) SeverityPolicy // In case of CVE policy this is same as cve name else it is blank Name string `json:"name,omitempty"` }
CvePolicy defines model for CvePolicy.
type DeletePolicyParams ¶
type DeletePolicyParams struct {
Id int `json:"id"`
}
DeletePolicyParams defines parameters for DeletePolicy.
type DeleteVulnerabilityPolicyResponse ¶
type DeleteVulnerabilityPolicyResponse struct { // Error object Error *Error `json:"error,omitempty"` Result *IdVulnerabilityPolicyResult `json:"result,omitempty"` }
DeleteVulnerabilityPolicyResponse defines model for DeleteVulnerabilityPolicyResponse.
type DeploymentConfigurationType ¶ added in v0.6.2
type DeploymentConfigurationType string
type DeploymentDetailContainer ¶
type DeploymentDetailContainer struct { InstalledAppId int `json:"installedAppId,omitempty"` AppId int `json:"appId,omitempty"` AppStoreInstalledAppVersionId int `json:"appStoreInstalledAppVersionId,omitempty"` AppStoreChartName string `json:"appStoreChartName,omitempty"` AppStoreChartId int `json:"appStoreChartId,omitempty"` AppStoreAppName string `json:"appStoreAppName,omitempty"` AppStoreAppVersion string `json:"appStoreAppVersion,omitempty"` AppName string `json:"appName"` EnvironmentId int `json:"environmentId"` EnvironmentName string `json:"environmentName"` Namespace string `json:"namespace,omitempty"` Status string `json:"status,omitempty"` StatusMessage string `json:"statusMessage,omitempty"` LastDeployedTime string `json:"lastDeployedTime,omitempty"` LastDeployedBy string `json:"lastDeployedBy,omitempty"` MaterialInfo json.RawMessage `json:"materialInfo,omitempty"` MaterialInfoJsonString string `json:"-"` ReleaseVersion string `json:"releaseVersion,omitempty"` Default bool `json:"default,omitempty"` DataSource string `json:"dataSource,omitempty"` LastDeployedPipeline string `json:"lastDeployedPipeline,omitempty"` Deprecated bool `json:"deprecated"` K8sVersion string `json:"k8sVersion"` CiArtifactId int `json:"ciArtifactId"` ClusterId int `json:"clusterId"` DeploymentAppType string `json:"deploymentAppType"` CiPipelineId int `json:"-"` IsExternalCi bool `json:"externalCi"` ClusterName string `json:"clusterName,omitempty"` DockerRegistryId string `json:"dockerRegistryId,omitempty"` IpsAccessProvided bool `json:"ipsAccessProvided"` DeploymentAppDeleteRequest bool `json:"deploymentAppDeleteRequest"` Description string `json:"description" validate:"max=40"` IsVirtualEnvironment bool `json:"isVirtualEnvironment"` }
type DeploymentDetailStat ¶
type DeploymentDetailStat struct { AppId int `json:"appId"` EnvironmentId int `json:"environmentId"` NewPodStats PodDetailStat `json:"newPodStats,omitempty"` OldPodStats PodDetailStat `json:"oldPodStats,omitempty"` }
type DeploymentGroupDTO ¶
type Environment ¶
type Environment struct { AppStatus string `json:"appStatus"` //this is not the status of environment , this make sense with a specific app only EnvironmentId int `json:"environmentId"` EnvironmentName string `json:"environmentName"` AppMetrics *bool `json:"appMetrics"` InfraMetrics *bool `json:"infraMetrics"` Prod bool `json:"prod"` ChartRefId int `json:"chartRefId"` LastDeployed string `json:"lastDeployed"` DeploymentAppDeleteRequest bool `json:"deploymentAppDeleteRequest"` Description string `json:"description" validate:"max=40"` IsVirtualEnvironment bool `json:"isVirtualEnvironment"` }
type Error ¶
type Error struct { // Error code Code int32 `json:"code"` // Error message Message string `json:"message"` }
Error defines model for Error.
type FetchPolicyParams ¶
type FetchPolicyParams struct { Level ResourceLevel `json:"level"` Id int `json:"id,omitempty"` }
FetchPolicyParams defines parameters for FetchPolicy.
type GetVulnerabilityPolicyResponse ¶
type GetVulnerabilityPolicyResponse struct { // Error object Error *Error `json:"error,omitempty"` Result *GetVulnerabilityPolicyResult `json:"result,omitempty"` }
GetVulnerabilityPolicyResponse defines model for GetVulnerabilityPolicyResponse.
type GetVulnerabilityPolicyResult ¶
type GetVulnerabilityPolicyResult struct { // Resource Level can be one of global, cluster, environment, application Level ResourceLevel `json:"level"` Policies []*VulnerabilityPolicy `json:"policies"` }
GetVulnerabilityPolicyResult defines model for GetVulnerabilityPolicyResult.
type GitOpsConfigDto ¶ added in v0.2.27
type GitOpsConfigDto struct { Id int `json:"id,omitempty"` Provider string `json:"provider"` Username string `json:"username"` Token string `json:"token"` GitLabGroupId string `json:"gitLabGroupId"` GitHubOrgId string `json:"gitHubOrgId"` Host string `json:"host"` Active bool `json:"active"` AzureProjectName string `json:"azureProjectName"` BitBucketWorkspaceId string `json:"bitBucketWorkspaceId"` BitBucketProjectKey string `json:"bitBucketProjectKey"` GitRepoName string `json:"gitRepoName"` UserEmailId string `json:"userEmailId"` Description string `json:"description"` UserId int32 `json:"-"` }
type GitRepoRequestDto ¶ added in v0.6.11
type GitRepoRequestDto struct { Host string `json:"host"` Provider string `json:"provider"` GitRepoName string `json:"gitRepoName"` Username string `json:"username"` UserEmailId string `json:"userEmailId"` Token string `json:"token"` GitLabGroupId string `json:"gitLabGroupId"` GitHubOrgId string `json:"gitHubOrgId"` AzureProjectName string `json:"azureProjectName"` BitBucketWorkspaceId string `json:"bitBucketWorkspaceId"` BitBucketProjectKey string `json:"bitBucketProjectKey"` }
type IdVulnerabilityPolicyResult ¶
type IdVulnerabilityPolicyResult struct {
Id int `json:"id"`
}
IdVulnerabilityPolicyResult defines model for IdVulnerabilityPolicyResult.
type InstanceDetail ¶
type InstanceDetail struct { PodName string `json:"podName,omitempty"` CpuUsage float64 `json:"cpuUsage,omitempty"` MemoryUsage int64 `json:"memoryUsage,omitempty"` CpuRequest float64 `json:"cpuRequest,omitempty"` MemoryRequest int64 `json:"memoryRequest,omitempty"` CpuUsagePercent float64 `json:"cpuUsagePercent,omitempty"` MemoryUsagePercent float64 `json:"memoryUsagePercent,omitempty"` }
type JobCIPipeline ¶ added in v0.6.15
type JobContainer ¶ added in v0.6.15
type JobContainer struct { JobId int `json:"jobId"` JobName string `json:"jobName""` Description string `json:"description"` JobCiPipelines []JobCIPipeline `json:"ciPipelines"'` }
type JobContainerResponse ¶ added in v0.6.15
type JobContainerResponse struct { JobContainers []*JobContainer `json:"jobContainers"` JobCount int `json:"jobCount"` }
type JobListingContainer ¶ added in v0.6.15
type LinkOuts ¶
type LinkOuts struct { Id int `json:"id"` AppId int `json:"appId,omitempty"` EnvironmentId int `json:"environmentId,omitempty"` Name string `json:"name"` AppName string `json:"appName,omitempty"` EnvName string `json:"envName,omitempty"` PodName string `json:"podName,omitempty"` ContainerName string `json:"containerName,omitempty"` Link string `json:"link,omitempty"` Description string `json:"description,omitempty"` }
type PodDetailStat ¶
type PolicyRequest ¶
type PolicyType ¶
type PolicyType int
type ReleaseStatusUpdateRequest ¶
type ReleaseStatusUpdateRequest struct { RequestId string `json:"requestId"` NewStatus models.ChartStatus `json:"newStatus"` }
type ResourceTreeAndNotesContainer ¶ added in v0.6.17
type ResourceUsage ¶
type Response ¶
type Response struct { Code int `json:"code,omitempty"` Status string `json:"status,omitempty"` Result interface{} `json:"result,omitempty"` Errors []ApiError `json:"errors,omitempty"` }
global response body used across api
type RoleData ¶
type RoleData struct { Id int `json:"id" validate:"number"` Role string `json:"role" validate:"required"` Entity string `json:"entity"` Team string `json:"team"` EntityName string `json:"entityName"` Environment string `json:"environment"` Action string `json:"action"` AccessType string `json:"accessType"` Cluster string `json:"cluster"` Namespace string `json:"namespace"` Group string `json:"group"` Kind string `json:"kind"` Resource string `json:"resource"` }
type RoleFilter ¶
type RoleFilter struct { Entity string `json:"entity"` Team string `json:"team"` EntityName string `json:"entityName"` Environment string `json:"environment"` Action string `json:"action"` AccessType string `json:"accessType"` Cluster string `json:"cluster"` Namespace string `json:"namespace"` Group string `json:"group"` Kind string `json:"kind"` Resource string `json:"resource"` }
type SSOLoginDto ¶
type SeverityPolicy ¶
type SeverityPolicy struct { Id int `json:"id"` // Whether vulnerability is allowed or blocked and is it inherited or is it overridden Policy *VulnerabilityPermission `json:"policy"` PolicyOrigin string `json:"policyOrigin"` Severity string `json:"severity"` }
SeverityPolicy defines model for SeverityPolicy.
type TriggerEvent ¶ added in v0.6.17
type TriggerView ¶
type TriggerView struct { CiPipelineId int `json:"ciPipelineId"` CiPipelineName string `json:"ciPipelineName"` CdPipelineId int `json:"cdPipelineId"` CdPipelineName string `json:"cdPipelineName"` Status string `json:"status"` StatusMessage string `json:"statusMessage,omitempty"` LastDeployedTime string `json:"lastDeployedTime,omitempty"` LastDeployedBy string `json:"lastDeployedBy,omitempty"` MaterialInfo json.RawMessage `json:"materialInfo,omitempty"` MaterialInfoJsonString string `json:"-"` ReleaseVersion string `json:"releaseVersion,omitempty"` DataSource string `json:"dataSource,omitempty"` Conditions []v1alpha1.ApplicationCondition `json:"conditions"` AppName string `json:"appName"` EnvironmentName string `json:"environmentName"` }
type UpdatePolicyParams ¶
UpdatePolicyParams defines parameters for UpdatePolicy.
type UpdateVulnerabilityPolicyResponse ¶
type UpdateVulnerabilityPolicyResponse struct { // Error object Error *Error `json:"error,omitempty"` Result *IdVulnerabilityPolicyResult `json:"result,omitempty"` }
UpdateVulnerabilityPolicyResponse defines model for UpdateVulnerabilityPolicyResponse.
type UserInfo ¶
type UserInfo struct { Id int32 `json:"id" validate:"number"` EmailId string `json:"email_id" validate:"required"` Roles []string `json:"roles,omitempty"` AccessToken string `json:"access_token,omitempty"` UserType string `json:"-"` LastUsedAt time.Time `json:"-"` LastUsedByIp string `json:"-"` Exist bool `json:"-"` UserId int32 `json:"-"` // created or modified user id RoleFilters []RoleFilter `json:"roleFilters"` Status string `json:"status,omitempty"` Groups []string `json:"groups"` SuperAdmin bool `json:"superAdmin,notnull"` }
type ValuesOverrideRequest ¶
type ValuesOverrideRequest struct { PipelineId int `json:"pipelineId" validate:"required"` AppId int `json:"appId" validate:"required"` CiArtifactId int `json:"ciArtifactId" validate:"required"` AdditionalOverride json.RawMessage `json:"additionalOverride,omitempty"` TargetDbVersion int `json:"targetDbVersion"` ForceTrigger bool `json:"forceTrigger,notnull"` DeploymentTemplate string `json:"strategy,omitempty"` // validate:"oneof=BLUE-GREEN ROLLING"` DeploymentWithConfig DeploymentConfigurationType `json:"deploymentWithConfig"` WfrIdForDeploymentWithSpecificTrigger int `json:"wfrIdForDeploymentWithSpecificTrigger"` CdWorkflowType WorkflowType `json:"cdWorkflowType,notnull"` WfrId int `json:"wfrId,notnull"` CdWorkflowId int `json:"cdWorkflowId"` UserId int32 `json:"-"` DeploymentType models.DeploymentType `json:"-"` EnvId int `json:"-"` EnvName string `json:"-"` ClusterId int `json:"-"` AppName string `json:"-"` PipelineName string `json:"-"` DeploymentAppType string `json:"-"` }
type VulnerabilityAction ¶
type VulnerabilityAction string
VulnerabilityAction defines model for VulnerabilityAction.
type VulnerabilityPermission ¶
type VulnerabilityPermission struct { // actions which can be taken on vulnerabilities Action VulnerabilityAction `json:"action"` Inherited bool `json:"inherited"` IsOverriden bool `json:"isOverriden"` }
VulnerabilityPermission defines model for VulnerabilityPermission.
type VulnerabilityPolicy ¶
type VulnerabilityPolicy struct { Cves []*CvePolicy `json:"cves"` // environment id in case of application EnvId int `json:"envId,omitempty"` // Is name of cluster or environment or application/environment Name string `json:"name,omitempty"` Severities []*SeverityPolicy `json:"severities"` AppId int `json:"-"` ClusterId int `json:"-"` }
VulnerabilityPolicy defines model for VulnerabilityPolicy.
type WorkflowType ¶ added in v0.3.12
type WorkflowType string