-
Notifications
You must be signed in to change notification settings - Fork 786
/
interface.go
161 lines (114 loc) · 6.15 KB
/
interface.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
package cmd
import (
"io"
"github.com/jenkins-x/jx/pkg/io/secrets"
"github.com/jenkins-x/jx/pkg/vault"
"github.com/heptio/sonobuoy/pkg/dynamic"
"github.com/jenkins-x/jx/pkg/helm"
"github.com/heptio/sonobuoy/pkg/client"
"github.com/jenkins-x/jx/pkg/gits"
"github.com/jenkins-x/jx/pkg/table"
"gopkg.in/AlecAivazis/survey.v1/terminal"
"github.com/jenkins-x/golang-jenkins"
"github.com/jenkins-x/jx/pkg/auth"
"github.com/jenkins-x/jx/pkg/client/clientset/versioned"
corev1 "k8s.io/api/core/v1"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
vaultoperatorclient "github.com/banzaicloud/bank-vaults/operator/pkg/client/clientset/versioned"
certmngclient "github.com/jetstack/cert-manager/pkg/client/clientset/versioned"
kpipelineclient "github.com/knative/build-pipeline/pkg/client/clientset/versioned"
buildclient "github.com/knative/build/pkg/client/clientset/versioned"
apiextensionsclientset "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset"
metricsclient "k8s.io/metrics/pkg/client/clientset/versioned"
// this is so that we load the auth plugins so we can connect to, say, GCP
_ "k8s.io/client-go/plugin/pkg/client/auth"
)
// Factory is the interface defined for jx interactions via the cli
//go:generate pegomock generate github.com/jenkins-x/jx/pkg/jx/cmd Factory -o mocks/factory.go --generate-matchers
type Factory interface {
//
// Constructors
//
// WithBearerToken creates a factory from a k8s bearer token
WithBearerToken(token string) Factory
// ImpersonateUser creates a factory with an impersonated users
ImpersonateUser(user string) Factory
//
// Configuration services
//
// CreateAuthConfigService creates a new authentication configuration service
CreateAuthConfigService(fileName string) (auth.ConfigService, error)
// CreateJenkinsAuthConfigService creates a new Jenkins authentication configuration service
CreateJenkinsAuthConfigService(kubernetes.Interface, string) (auth.ConfigService, error)
// CreateChartmuseumAuthConfigService creates a new Chartmuseum authentication configuration service
CreateChartmuseumAuthConfigService() (auth.ConfigService, error)
// CreateIssueTrackerAuthConfigService creates a new issuer tracker configuration service
CreateIssueTrackerAuthConfigService(secrets *corev1.SecretList) (auth.ConfigService, error)
// CreateChatAuthConfigService creates a new chat configuration service
CreateChatAuthConfigService(secrets *corev1.SecretList) (auth.ConfigService, error)
// CreateAddonAuthConfigService creates a new addon auth configuration service
CreateAddonAuthConfigService(secrets *corev1.SecretList) (auth.ConfigService, error)
//
// Generic clients
//
// CreateJenkinsClient creates a new Jenkins client
CreateJenkinsClient(kubeClient kubernetes.Interface, ns string, in terminal.FileReader, out terminal.FileWriter, errOut io.Writer) (gojenkins.JenkinsClient, error)
// CreateGitProvider creates a new Git provider
CreateGitProvider(string, string, auth.ConfigService, string, bool, gits.Gitter, terminal.FileReader, terminal.FileWriter, io.Writer) (gits.GitProvider, error)
// CreateComplianceClient creates a new compliance client
CreateComplianceClient() (*client.SonobuoyClient, error)
// CreateSystemVaultClient creates the system vault client for managing the secrets
CreateSystemVaultClient(namespace string) (vault.Client, error)
// CreateVaultClient returns the vault client for given vault
CreateVaultClient(name string, namespace string) (vault.Client, error)
// CreateHelm creates a new helm client
CreateHelm(verbose bool, helmBinary string, noTiller bool, helmTemplate bool) helm.Helmer
//
// Kubernetes clients
//
// CreateKubeClient creates a new Kubernetes client
CreateKubeClient() (kubernetes.Interface, string, error)
// CreateKubeConfig creates the kubernetes configuration
CreateKubeConfig() (*rest.Config, error)
// CreateJXClient creates a new Kubernetes client for Jenkins X CRDs
CreateJXClient() (versioned.Interface, string, error)
// CreateApiExtensionsClient creates a new Kubernetes ApiExtensions client
CreateApiExtensionsClient() (apiextensionsclientset.Interface, error)
// CreateDynamicClient creates a new Kubernetes Dynamic client
CreateDynamicClient() (*dynamic.APIHelper, string, error)
// CreateMetricsClient creates a new Kubernetes metrics client
CreateMetricsClient() (*metricsclient.Clientset, error)
// CreateKnativePipelineClient create a new Kubernetes client for Knative Pipeline resources
CreateKnativePipelineClient() (kpipelineclient.Interface, string, error)
// CreateKnativeBuildClient create a new Kubernetes client for Knative resources
CreateKnativeBuildClient() (buildclient.Interface, string, error)
// CreateVaultOperatorClient creates a new Kubernetes client for Vault operator resources
CreateVaultOperatorClient() (vaultoperatorclient.Interface, error)
// CreateCertManagerClient creates a new Kubernetes client for cert-manager resources
CreateCertManagerClient() (certmngclient.Interface, error)
//
// Other methods
//
// CreateTable creates a new table
CreateTable(out io.Writer) table.Table
// GetJenkinsURL returns the Jenkins URL
GetJenkinsURL(kubeClient kubernetes.Interface, ns string) (string, error)
// SetBatch configures the batch modes
SetBatch(batch bool)
// For tests only, assert that no actual network connections are being made.
SetOffline(offline bool)
// IsInCluster indicates if the execution takes place within a Kubernetes cluster
IsInCluster() bool
// IsInCDPipeline indicates if the execution takes place within a CD pipeline
IsInCDPipeline() bool
// AuthMergePipelineSecrets merges the current config with the pipeline secrets provided in k8s secrets
AuthMergePipelineSecrets(config *auth.AuthConfig, secrets *corev1.SecretList, kind string, isCDPipeline bool) error
// SecretsLocation inidcates the location of the secrets
SecretsLocation() secrets.SecretsLocationKind
// SetSecretsLocation configures the secrets location in memory. It will persist the secrets location in a
// config map if the persist flag is active.
SetSecretsLocation(location secrets.SecretsLocationKind, persist bool) error
// ResetSecretsLocation resets the location of the secrets
ResetSecretsLocation()
}