agent.go 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206
  1. package kubernetes
  2. import (
  3. "bufio"
  4. "bytes"
  5. "compress/gzip"
  6. "context"
  7. "encoding/base64"
  8. "encoding/json"
  9. "fmt"
  10. "io"
  11. "io/ioutil"
  12. "strings"
  13. "time"
  14. goerrors "errors"
  15. "github.com/porter-dev/porter/api/server/shared/websocket"
  16. "github.com/porter-dev/porter/internal/kubernetes/provisioner"
  17. "github.com/porter-dev/porter/internal/models"
  18. "github.com/porter-dev/porter/internal/registry"
  19. "github.com/porter-dev/porter/internal/repository"
  20. "golang.org/x/oauth2"
  21. errors2 "errors"
  22. "github.com/porter-dev/porter/internal/helm/grapher"
  23. appsv1 "k8s.io/api/apps/v1"
  24. batchv1 "k8s.io/api/batch/v1"
  25. batchv1beta1 "k8s.io/api/batch/v1beta1"
  26. v1 "k8s.io/api/core/v1"
  27. v1beta1 "k8s.io/api/extensions/v1beta1"
  28. "k8s.io/apimachinery/pkg/api/errors"
  29. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  30. "k8s.io/apimachinery/pkg/fields"
  31. "k8s.io/apimachinery/pkg/runtime"
  32. "k8s.io/apimachinery/pkg/runtime/schema"
  33. "k8s.io/apimachinery/pkg/types"
  34. "k8s.io/apimachinery/pkg/watch"
  35. "k8s.io/cli-runtime/pkg/genericclioptions"
  36. "k8s.io/client-go/informers"
  37. "k8s.io/client-go/kubernetes"
  38. "k8s.io/client-go/rest"
  39. "k8s.io/client-go/tools/cache"
  40. "k8s.io/client-go/tools/remotecommand"
  41. rspb "helm.sh/helm/v3/pkg/release"
  42. )
  43. // Agent is a Kubernetes agent for performing operations that interact with the
  44. // api server
  45. type Agent struct {
  46. RESTClientGetter genericclioptions.RESTClientGetter
  47. Clientset kubernetes.Interface
  48. }
  49. type Message struct {
  50. EventType string `json:"event_type"`
  51. Object interface{}
  52. Kind string
  53. }
  54. type ListOptions struct {
  55. FieldSelector string
  56. }
  57. type AuthError struct{}
  58. func (e *AuthError) Error() string {
  59. return "Unauthorized error"
  60. }
  61. // UpdateClientset updates the Agent's Clientset (this refreshes auth tokens)
  62. func (a *Agent) UpdateClientset() error {
  63. restConf, err := a.RESTClientGetter.ToRESTConfig()
  64. if err != nil {
  65. return err
  66. }
  67. clientset, err := kubernetes.NewForConfig(restConf)
  68. if err != nil {
  69. return err
  70. }
  71. a.Clientset = clientset
  72. return nil
  73. }
  74. // CreateConfigMap creates the configmap given the key-value pairs and namespace
  75. func (a *Agent) CreateConfigMap(name string, namespace string, configMap map[string]string) (*v1.ConfigMap, error) {
  76. return a.Clientset.CoreV1().ConfigMaps(namespace).Create(
  77. context.TODO(),
  78. &v1.ConfigMap{
  79. ObjectMeta: metav1.ObjectMeta{
  80. Name: name,
  81. Namespace: namespace,
  82. Labels: map[string]string{
  83. "porter": "true",
  84. },
  85. },
  86. Data: configMap,
  87. },
  88. metav1.CreateOptions{},
  89. )
  90. }
  91. // CreateLinkedSecret creates a secret given the key-value pairs and namespace. Values are
  92. // base64 encoded
  93. func (a *Agent) CreateLinkedSecret(name, namespace, cmName string, data map[string][]byte) (*v1.Secret, error) {
  94. return a.Clientset.CoreV1().Secrets(namespace).Create(
  95. context.TODO(),
  96. &v1.Secret{
  97. ObjectMeta: metav1.ObjectMeta{
  98. Name: name,
  99. Namespace: namespace,
  100. Labels: map[string]string{
  101. "porter": "true",
  102. "configmap": cmName,
  103. },
  104. },
  105. Data: data,
  106. },
  107. metav1.CreateOptions{},
  108. )
  109. }
  110. type mergeConfigMapData struct {
  111. Data map[string]*string `json:"data"`
  112. }
  113. // UpdateConfigMap updates the configmap given its name and namespace
  114. func (a *Agent) UpdateConfigMap(name string, namespace string, configMap map[string]string) (*v1.ConfigMap, error) {
  115. cmData := make(map[string]*string)
  116. for key, val := range configMap {
  117. valCopy := val
  118. cmData[key] = &valCopy
  119. if len(val) == 0 {
  120. cmData[key] = nil
  121. }
  122. }
  123. mergeCM := &mergeConfigMapData{
  124. Data: cmData,
  125. }
  126. patchBytes, err := json.Marshal(mergeCM)
  127. if err != nil {
  128. return nil, err
  129. }
  130. return a.Clientset.CoreV1().ConfigMaps(namespace).Patch(
  131. context.Background(),
  132. name,
  133. types.MergePatchType,
  134. patchBytes,
  135. metav1.PatchOptions{},
  136. )
  137. }
  138. type mergeLinkedSecretData struct {
  139. Data map[string]*[]byte `json:"data"`
  140. }
  141. // UpdateLinkedSecret updates the secret given its name and namespace
  142. func (a *Agent) UpdateLinkedSecret(name, namespace, cmName string, data map[string][]byte) error {
  143. secretData := make(map[string]*[]byte)
  144. for key, val := range data {
  145. valCopy := val
  146. secretData[key] = &valCopy
  147. if len(val) == 0 {
  148. secretData[key] = nil
  149. }
  150. }
  151. mergeSecret := &mergeLinkedSecretData{
  152. Data: secretData,
  153. }
  154. patchBytes, err := json.Marshal(mergeSecret)
  155. if err != nil {
  156. return err
  157. }
  158. _, err = a.Clientset.CoreV1().Secrets(namespace).Patch(
  159. context.TODO(),
  160. name,
  161. types.MergePatchType,
  162. patchBytes,
  163. metav1.PatchOptions{},
  164. )
  165. return err
  166. }
  167. // DeleteConfigMap deletes the configmap given its name and namespace
  168. func (a *Agent) DeleteConfigMap(name string, namespace string) error {
  169. return a.Clientset.CoreV1().ConfigMaps(namespace).Delete(
  170. context.TODO(),
  171. name,
  172. metav1.DeleteOptions{},
  173. )
  174. }
  175. // DeleteLinkedSecret deletes the secret given its name and namespace
  176. func (a *Agent) DeleteLinkedSecret(name, namespace string) error {
  177. return a.Clientset.CoreV1().Secrets(namespace).Delete(
  178. context.TODO(),
  179. name,
  180. metav1.DeleteOptions{},
  181. )
  182. }
  183. // GetConfigMap retrieves the configmap given its name and namespace
  184. func (a *Agent) GetConfigMap(name string, namespace string) (*v1.ConfigMap, error) {
  185. return a.Clientset.CoreV1().ConfigMaps(namespace).Get(
  186. context.TODO(),
  187. name,
  188. metav1.GetOptions{},
  189. )
  190. }
  191. // GetSecret retrieves the secret given its name and namespace
  192. func (a *Agent) GetSecret(name string, namespace string) (*v1.Secret, error) {
  193. return a.Clientset.CoreV1().Secrets(namespace).Get(
  194. context.TODO(),
  195. name,
  196. metav1.GetOptions{},
  197. )
  198. }
  199. // ListConfigMaps simply lists namespaces
  200. func (a *Agent) ListConfigMaps(namespace string) (*v1.ConfigMapList, error) {
  201. return a.Clientset.CoreV1().ConfigMaps(namespace).List(
  202. context.TODO(),
  203. metav1.ListOptions{
  204. LabelSelector: "porter=true",
  205. },
  206. )
  207. }
  208. // ListEvents lists the events of a given object.
  209. func (a *Agent) ListEvents(name string, namespace string) (*v1.EventList, error) {
  210. return a.Clientset.CoreV1().Events(namespace).List(
  211. context.TODO(),
  212. metav1.ListOptions{
  213. FieldSelector: fmt.Sprintf("involvedObject.name=%s,involvedObject.namespace=%s", name, namespace),
  214. },
  215. )
  216. }
  217. // ListNamespaces simply lists namespaces
  218. func (a *Agent) ListNamespaces() (*v1.NamespaceList, error) {
  219. return a.Clientset.CoreV1().Namespaces().List(
  220. context.TODO(),
  221. metav1.ListOptions{},
  222. )
  223. }
  224. // CreateNamespace creates a namespace with the given name.
  225. func (a *Agent) CreateNamespace(name string) (*v1.Namespace, error) {
  226. // check if namespace exists
  227. checkNS, err := a.Clientset.CoreV1().Namespaces().Get(
  228. context.TODO(),
  229. name,
  230. metav1.GetOptions{},
  231. )
  232. if err == nil && checkNS != nil {
  233. return checkNS, nil
  234. }
  235. namespace := v1.Namespace{
  236. ObjectMeta: metav1.ObjectMeta{
  237. Name: name,
  238. },
  239. }
  240. return a.Clientset.CoreV1().Namespaces().Create(
  241. context.TODO(),
  242. &namespace,
  243. metav1.CreateOptions{},
  244. )
  245. }
  246. // DeleteNamespace deletes the namespace given the name.
  247. func (a *Agent) DeleteNamespace(name string) error {
  248. return a.Clientset.CoreV1().Namespaces().Delete(
  249. context.TODO(),
  250. name,
  251. metav1.DeleteOptions{},
  252. )
  253. }
  254. func (a *Agent) GetPorterAgent() (*appsv1.Deployment, error) {
  255. depl, err := a.Clientset.AppsV1().Deployments("porter-agent-system").Get(
  256. context.TODO(),
  257. "porter-agent-controller-manager",
  258. metav1.GetOptions{},
  259. )
  260. if err != nil && errors.IsNotFound(err) {
  261. return nil, IsNotFoundError
  262. }
  263. return depl, err
  264. }
  265. // ListJobsByLabel lists jobs in a namespace matching a label
  266. type Label struct {
  267. Key string
  268. Val string
  269. }
  270. func (a *Agent) ListJobsByLabel(namespace string, labels ...Label) ([]batchv1.Job, error) {
  271. selectors := make([]string, 0)
  272. for _, label := range labels {
  273. selectors = append(selectors, fmt.Sprintf("%s=%s", label.Key, label.Val))
  274. }
  275. resp, err := a.Clientset.BatchV1().Jobs(namespace).List(
  276. context.TODO(),
  277. metav1.ListOptions{
  278. LabelSelector: strings.Join(selectors, ","),
  279. },
  280. )
  281. if err != nil {
  282. return nil, err
  283. }
  284. return resp.Items, nil
  285. }
  286. // DeleteJob deletes the job in the given name and namespace.
  287. func (a *Agent) DeleteJob(name, namespace string) error {
  288. return a.Clientset.BatchV1().Jobs(namespace).Delete(
  289. context.TODO(),
  290. name,
  291. metav1.DeleteOptions{},
  292. )
  293. }
  294. // GetJobPods lists all pods belonging to a job in a namespace
  295. func (a *Agent) GetJobPods(namespace, jobName string) ([]v1.Pod, error) {
  296. resp, err := a.Clientset.CoreV1().Pods(namespace).List(
  297. context.TODO(),
  298. metav1.ListOptions{
  299. LabelSelector: fmt.Sprintf("%s=%s", "job-name", jobName),
  300. },
  301. )
  302. if err != nil {
  303. return nil, err
  304. }
  305. return resp.Items, nil
  306. }
  307. // GetIngress gets ingress given the name and namespace
  308. func (a *Agent) GetIngress(namespace string, name string) (*v1beta1.Ingress, error) {
  309. resp, err := a.Clientset.ExtensionsV1beta1().Ingresses(namespace).Get(
  310. context.TODO(),
  311. name,
  312. metav1.GetOptions{},
  313. )
  314. if err != nil && errors.IsNotFound(err) {
  315. return nil, IsNotFoundError
  316. } else if err != nil {
  317. return nil, err
  318. }
  319. return resp, nil
  320. }
  321. var IsNotFoundError = fmt.Errorf("not found")
  322. type BadRequestError struct {
  323. msg string
  324. }
  325. func (e *BadRequestError) Error() string {
  326. return e.msg
  327. }
  328. // GetDeployment gets the deployment given the name and namespace
  329. func (a *Agent) GetDeployment(c grapher.Object) (*appsv1.Deployment, error) {
  330. res, err := a.Clientset.AppsV1().Deployments(c.Namespace).Get(
  331. context.TODO(),
  332. c.Name,
  333. metav1.GetOptions{},
  334. )
  335. if err != nil && errors.IsNotFound(err) {
  336. return nil, IsNotFoundError
  337. } else if err != nil {
  338. return nil, err
  339. }
  340. res.Kind = c.Kind
  341. return res, nil
  342. }
  343. // GetStatefulSet gets the statefulset given the name and namespace
  344. func (a *Agent) GetStatefulSet(c grapher.Object) (*appsv1.StatefulSet, error) {
  345. res, err := a.Clientset.AppsV1().StatefulSets(c.Namespace).Get(
  346. context.TODO(),
  347. c.Name,
  348. metav1.GetOptions{},
  349. )
  350. if err != nil && errors.IsNotFound(err) {
  351. return nil, IsNotFoundError
  352. } else if err != nil {
  353. return nil, err
  354. }
  355. res.Kind = c.Kind
  356. return res, nil
  357. }
  358. // GetReplicaSet gets the replicaset given the name and namespace
  359. func (a *Agent) GetReplicaSet(c grapher.Object) (*appsv1.ReplicaSet, error) {
  360. res, err := a.Clientset.AppsV1().ReplicaSets(c.Namespace).Get(
  361. context.TODO(),
  362. c.Name,
  363. metav1.GetOptions{},
  364. )
  365. if err != nil && errors.IsNotFound(err) {
  366. return nil, IsNotFoundError
  367. } else if err != nil {
  368. return nil, err
  369. }
  370. res.Kind = c.Kind
  371. return res, nil
  372. }
  373. // GetDaemonSet gets the daemonset by name and namespace
  374. func (a *Agent) GetDaemonSet(c grapher.Object) (*appsv1.DaemonSet, error) {
  375. res, err := a.Clientset.AppsV1().DaemonSets(c.Namespace).Get(
  376. context.TODO(),
  377. c.Name,
  378. metav1.GetOptions{},
  379. )
  380. if err != nil && errors.IsNotFound(err) {
  381. return nil, IsNotFoundError
  382. } else if err != nil {
  383. return nil, err
  384. }
  385. res.Kind = c.Kind
  386. return res, nil
  387. }
  388. // GetJob gets the job by name and namespace
  389. func (a *Agent) GetJob(c grapher.Object) (*batchv1.Job, error) {
  390. res, err := a.Clientset.BatchV1().Jobs(c.Namespace).Get(
  391. context.TODO(),
  392. c.Name,
  393. metav1.GetOptions{},
  394. )
  395. if err != nil && errors.IsNotFound(err) {
  396. return nil, IsNotFoundError
  397. } else if err != nil {
  398. return nil, err
  399. }
  400. res.Kind = c.Kind
  401. return res, nil
  402. }
  403. // GetCronJob gets the CronJob by name and namespace
  404. func (a *Agent) GetCronJob(c grapher.Object) (*batchv1beta1.CronJob, error) {
  405. res, err := a.Clientset.BatchV1beta1().CronJobs(c.Namespace).Get(
  406. context.TODO(),
  407. c.Name,
  408. metav1.GetOptions{},
  409. )
  410. if err != nil && errors.IsNotFound(err) {
  411. return nil, IsNotFoundError
  412. } else if err != nil {
  413. return nil, err
  414. }
  415. res.Kind = c.Kind
  416. return res, nil
  417. }
  418. // GetPodsByLabel retrieves pods with matching labels
  419. func (a *Agent) GetPodsByLabel(selector string, namespace string) (*v1.PodList, error) {
  420. // Search in all namespaces for matching pods
  421. return a.Clientset.CoreV1().Pods(namespace).List(
  422. context.TODO(),
  423. metav1.ListOptions{
  424. LabelSelector: selector,
  425. },
  426. )
  427. }
  428. // GetPodByName retrieves a single instance of pod with given name
  429. func (a *Agent) GetPodByName(name string, namespace string) (*v1.Pod, error) {
  430. // Get pod by name
  431. pod, err := a.Clientset.CoreV1().Pods(namespace).Get(
  432. context.TODO(),
  433. name,
  434. metav1.GetOptions{},
  435. )
  436. if err != nil && errors.IsNotFound(err) {
  437. return nil, IsNotFoundError
  438. }
  439. if err != nil {
  440. return nil, err
  441. }
  442. return pod, nil
  443. }
  444. // DeletePod deletes a pod by name and namespace
  445. func (a *Agent) DeletePod(namespace string, name string) error {
  446. err := a.Clientset.CoreV1().Pods(namespace).Delete(
  447. context.TODO(),
  448. name,
  449. metav1.DeleteOptions{},
  450. )
  451. if err != nil && errors.IsNotFound(err) {
  452. return IsNotFoundError
  453. }
  454. return err
  455. }
  456. // GetPodLogs streams real-time logs from a given pod.
  457. func (a *Agent) GetPodLogs(namespace string, name string, showPreviousLogs bool, selectedContainer string, rw *websocket.WebsocketSafeReadWriter) error {
  458. // get the pod to read in the list of contains
  459. pod, err := a.Clientset.CoreV1().Pods(namespace).Get(
  460. context.Background(),
  461. name,
  462. metav1.GetOptions{},
  463. )
  464. if err != nil && errors.IsNotFound(err) {
  465. return IsNotFoundError
  466. } else if err != nil {
  467. return fmt.Errorf("Cannot get logs from pod %s: %s", name, err.Error())
  468. }
  469. // see if container is ready and able to open a stream. If not, wait for container
  470. // to be ready.
  471. err, _ = a.waitForPod(pod)
  472. if err != nil && goerrors.Is(err, IsNotFoundError) {
  473. return IsNotFoundError
  474. } else if err != nil {
  475. return fmt.Errorf("Cannot get logs from pod %s: %s", name, err.Error())
  476. }
  477. container := pod.Spec.Containers[0].Name
  478. if len(selectedContainer) > 0 {
  479. container = selectedContainer
  480. }
  481. tails := int64(400)
  482. // follow logs
  483. podLogOpts := v1.PodLogOptions{
  484. Follow: true,
  485. TailLines: &tails,
  486. Container: container,
  487. Previous: showPreviousLogs,
  488. }
  489. req := a.Clientset.CoreV1().Pods(namespace).GetLogs(name, &podLogOpts)
  490. podLogs, err := req.Stream(context.TODO())
  491. // in the case of bad request errors, such as if the pod is stuck in "ContainerCreating",
  492. // we'd like to pass this through to the client.
  493. if err != nil && errors.IsBadRequest(err) {
  494. return &BadRequestError{err.Error()}
  495. } else if err != nil {
  496. return fmt.Errorf("Cannot open log stream for pod %s: %s", name, err.Error())
  497. }
  498. defer podLogs.Close()
  499. r := bufio.NewReader(podLogs)
  500. errorchan := make(chan error)
  501. go func() {
  502. // listens for websocket closing handshake
  503. for {
  504. if _, _, err := rw.ReadMessage(); err != nil {
  505. errorchan <- nil
  506. return
  507. }
  508. }
  509. }()
  510. go func() {
  511. for {
  512. select {
  513. case <-errorchan:
  514. defer close(errorchan)
  515. return
  516. default:
  517. }
  518. bytes, err := r.ReadBytes('\n')
  519. if _, writeErr := rw.Write(bytes); writeErr != nil {
  520. errorchan <- writeErr
  521. return
  522. }
  523. if err != nil {
  524. if err != io.EOF {
  525. errorchan <- err
  526. return
  527. }
  528. errorchan <- nil
  529. return
  530. }
  531. }
  532. }()
  533. for {
  534. select {
  535. case err = <-errorchan:
  536. return err
  537. }
  538. }
  539. }
  540. // StopJobWithJobSidecar sends a termination signal to a job running with a sidecar
  541. func (a *Agent) StopJobWithJobSidecar(namespace, name string) error {
  542. jobPods, err := a.GetJobPods(namespace, name)
  543. if err != nil {
  544. return err
  545. }
  546. podName := jobPods[0].ObjectMeta.Name
  547. restConf, err := a.RESTClientGetter.ToRESTConfig()
  548. restConf.GroupVersion = &schema.GroupVersion{
  549. Group: "api",
  550. Version: "v1",
  551. }
  552. restConf.NegotiatedSerializer = runtime.NewSimpleNegotiatedSerializer(runtime.SerializerInfo{})
  553. restClient, err := rest.RESTClientFor(restConf)
  554. if err != nil {
  555. return err
  556. }
  557. req := restClient.Post().
  558. Resource("pods").
  559. Name(podName).
  560. Namespace(namespace).
  561. SubResource("exec")
  562. req.Param("command", "./signal.sh")
  563. req.Param("container", "sidecar")
  564. req.Param("stdin", "true")
  565. req.Param("stdout", "false")
  566. req.Param("tty", "false")
  567. exec, err := remotecommand.NewSPDYExecutor(restConf, "POST", req.URL())
  568. if err != nil {
  569. return err
  570. }
  571. return exec.Stream(remotecommand.StreamOptions{
  572. Tty: false,
  573. Stdin: strings.NewReader("./signal.sh"),
  574. })
  575. }
  576. // RunWebsocketTask will run a websocket task. If the websocket returns an anauthorized error, it will restart
  577. // the task some number of times until failing
  578. func (a *Agent) RunWebsocketTask(task func() error) error {
  579. lastTime := int64(0)
  580. for {
  581. if err := a.UpdateClientset(); err != nil {
  582. return err
  583. }
  584. err := task()
  585. if err == nil {
  586. return nil
  587. }
  588. if !errors2.Is(err, &AuthError{}) {
  589. return err
  590. }
  591. if time.Now().Unix()-lastTime < 60 { // don't regenerate connection if too many unauthorized errors
  592. return err
  593. }
  594. lastTime = time.Now().Unix()
  595. }
  596. }
  597. // StreamControllerStatus streams controller status. Supports Deployment, StatefulSet, ReplicaSet, and DaemonSet
  598. // TODO: Support Jobs
  599. func (a *Agent) StreamControllerStatus(kind string, selectors string, rw *websocket.WebsocketSafeReadWriter) error {
  600. run := func() error {
  601. // selectors is an array of max length 1. StreamControllerStatus accepts calls without the selectors argument.
  602. // selectors argument is a single string with comma separated key=value pairs. (e.g. "app=porter,porter=true")
  603. tweakListOptionsFunc := func(options *metav1.ListOptions) {
  604. options.LabelSelector = selectors
  605. }
  606. factory := informers.NewSharedInformerFactoryWithOptions(
  607. a.Clientset,
  608. 0,
  609. informers.WithTweakListOptions(tweakListOptionsFunc),
  610. )
  611. var informer cache.SharedInformer
  612. // Spins up an informer depending on kind. Convert to lowercase for robustness
  613. switch strings.ToLower(kind) {
  614. case "deployment":
  615. informer = factory.Apps().V1().Deployments().Informer()
  616. case "statefulset":
  617. informer = factory.Apps().V1().StatefulSets().Informer()
  618. case "replicaset":
  619. informer = factory.Apps().V1().ReplicaSets().Informer()
  620. case "daemonset":
  621. informer = factory.Apps().V1().DaemonSets().Informer()
  622. case "job":
  623. informer = factory.Batch().V1().Jobs().Informer()
  624. case "cronjob":
  625. informer = factory.Batch().V1beta1().CronJobs().Informer()
  626. case "namespace":
  627. informer = factory.Core().V1().Namespaces().Informer()
  628. case "pod":
  629. informer = factory.Core().V1().Pods().Informer()
  630. }
  631. stopper := make(chan struct{})
  632. errorchan := make(chan error)
  633. defer close(stopper)
  634. informer.SetWatchErrorHandler(func(r *cache.Reflector, err error) {
  635. if strings.HasSuffix(err.Error(), ": Unauthorized") {
  636. errorchan <- &AuthError{}
  637. }
  638. })
  639. informer.AddEventHandler(cache.ResourceEventHandlerFuncs{
  640. UpdateFunc: func(oldObj, newObj interface{}) {
  641. msg := Message{
  642. EventType: "UPDATE",
  643. Object: newObj,
  644. Kind: strings.ToLower(kind),
  645. }
  646. rw.WriteJSONWithChannel(msg, errorchan)
  647. },
  648. AddFunc: func(obj interface{}) {
  649. msg := Message{
  650. EventType: "ADD",
  651. Object: obj,
  652. Kind: strings.ToLower(kind),
  653. }
  654. rw.WriteJSONWithChannel(msg, errorchan)
  655. },
  656. DeleteFunc: func(obj interface{}) {
  657. msg := Message{
  658. EventType: "DELETE",
  659. Object: obj,
  660. Kind: strings.ToLower(kind),
  661. }
  662. rw.WriteJSONWithChannel(msg, errorchan)
  663. },
  664. })
  665. go func() {
  666. // listens for websocket closing handshake
  667. for {
  668. if _, _, err := rw.ReadMessage(); err != nil {
  669. errorchan <- nil
  670. return
  671. }
  672. }
  673. }()
  674. go informer.Run(stopper)
  675. for {
  676. select {
  677. case err := <-errorchan:
  678. return err
  679. }
  680. }
  681. }
  682. return a.RunWebsocketTask(run)
  683. }
  684. var b64 = base64.StdEncoding
  685. var magicGzip = []byte{0x1f, 0x8b, 0x08}
  686. func decodeRelease(data string) (*rspb.Release, error) {
  687. // base64 decode string
  688. b, err := b64.DecodeString(data)
  689. if err != nil {
  690. return nil, err
  691. }
  692. // For backwards compatibility with releases that were stored before
  693. // compression was introduced we skip decompression if the
  694. // gzip magic header is not found
  695. if bytes.Equal(b[0:3], magicGzip) {
  696. r, err := gzip.NewReader(bytes.NewReader(b))
  697. if err != nil {
  698. return nil, err
  699. }
  700. defer r.Close()
  701. b2, err := ioutil.ReadAll(r)
  702. if err != nil {
  703. return nil, err
  704. }
  705. b = b2
  706. }
  707. var rls rspb.Release
  708. // unmarshal release object bytes
  709. if err := json.Unmarshal(b, &rls); err != nil {
  710. return nil, err
  711. }
  712. return &rls, nil
  713. }
  714. func contains(s []string, str string) bool {
  715. for _, v := range s {
  716. if v == str {
  717. return true
  718. }
  719. }
  720. return false
  721. }
  722. func ParseSecretToHelmRelease(secret v1.Secret, chartList []string) (*rspb.Release, bool, error) {
  723. if secret.Type != "helm.sh/release.v1" {
  724. return nil, true, nil
  725. }
  726. releaseData, ok := secret.Data["release"]
  727. if !ok {
  728. return nil, true, fmt.Errorf("release field not found")
  729. }
  730. helm_object, err := decodeRelease(string(releaseData))
  731. if err != nil {
  732. return nil, true, err
  733. }
  734. if len(chartList) > 0 && !contains(chartList, helm_object.Name) {
  735. return nil, true, nil
  736. }
  737. return helm_object, false, nil
  738. }
  739. func (a *Agent) StreamHelmReleases(namespace string, chartList []string, selectors string, rw *websocket.WebsocketSafeReadWriter) error {
  740. run := func() error {
  741. tweakListOptionsFunc := func(options *metav1.ListOptions) {
  742. options.LabelSelector = selectors
  743. }
  744. factory := informers.NewSharedInformerFactoryWithOptions(
  745. a.Clientset,
  746. 0,
  747. informers.WithTweakListOptions(tweakListOptionsFunc),
  748. informers.WithNamespace(namespace),
  749. )
  750. informer := factory.Core().V1().Secrets().Informer()
  751. stopper := make(chan struct{})
  752. errorchan := make(chan error)
  753. defer close(stopper)
  754. informer.SetWatchErrorHandler(func(r *cache.Reflector, err error) {
  755. if strings.HasSuffix(err.Error(), ": Unauthorized") {
  756. errorchan <- &AuthError{}
  757. }
  758. })
  759. informer.AddEventHandler(cache.ResourceEventHandlerFuncs{
  760. UpdateFunc: func(oldObj, newObj interface{}) {
  761. secretObj, ok := newObj.(*v1.Secret)
  762. if !ok {
  763. errorchan <- fmt.Errorf("could not cast to secret")
  764. return
  765. }
  766. helm_object, isNotHelmRelease, err := ParseSecretToHelmRelease(*secretObj, chartList)
  767. if isNotHelmRelease && err == nil {
  768. return
  769. }
  770. if err != nil {
  771. errorchan <- err
  772. return
  773. }
  774. msg := Message{
  775. EventType: "UPDATE",
  776. Object: helm_object,
  777. }
  778. rw.WriteJSONWithChannel(msg, errorchan)
  779. },
  780. AddFunc: func(obj interface{}) {
  781. secretObj, ok := obj.(*v1.Secret)
  782. if !ok {
  783. errorchan <- fmt.Errorf("could not cast to secret")
  784. return
  785. }
  786. helm_object, isNotHelmRelease, err := ParseSecretToHelmRelease(*secretObj, chartList)
  787. if isNotHelmRelease && err == nil {
  788. return
  789. }
  790. if err != nil {
  791. errorchan <- err
  792. return
  793. }
  794. msg := Message{
  795. EventType: "ADD",
  796. Object: helm_object,
  797. }
  798. rw.WriteJSONWithChannel(msg, errorchan)
  799. },
  800. DeleteFunc: func(obj interface{}) {
  801. secretObj, ok := obj.(*v1.Secret)
  802. if !ok {
  803. errorchan <- fmt.Errorf("could not cast to secret")
  804. return
  805. }
  806. helm_object, isNotHelmRelease, err := ParseSecretToHelmRelease(*secretObj, chartList)
  807. if isNotHelmRelease && err == nil {
  808. return
  809. }
  810. if err != nil {
  811. errorchan <- err
  812. return
  813. }
  814. msg := Message{
  815. EventType: "DELETE",
  816. Object: helm_object,
  817. }
  818. rw.WriteJSONWithChannel(msg, errorchan)
  819. },
  820. })
  821. go func() {
  822. // listens for websocket closing handshake
  823. for {
  824. if _, _, err := rw.ReadMessage(); err != nil {
  825. errorchan <- nil
  826. return
  827. }
  828. }
  829. }()
  830. go informer.Run(stopper)
  831. for {
  832. select {
  833. case err := <-errorchan:
  834. return err
  835. }
  836. }
  837. }
  838. return a.RunWebsocketTask(run)
  839. }
  840. func (a *Agent) Provision(
  841. opts *provisioner.ProvisionOpts,
  842. ) error {
  843. // get the provisioner job template
  844. job, err := provisioner.GetProvisionerJobTemplate(opts)
  845. if err != nil {
  846. return err
  847. }
  848. // apply the provisioner job template
  849. _, err = a.Clientset.BatchV1().Jobs(opts.ProvJobNamespace).Create(
  850. context.TODO(),
  851. job,
  852. metav1.CreateOptions{},
  853. )
  854. return err
  855. }
  856. // CreateImagePullSecrets will create the required image pull secrets and
  857. // return a map from the registry name to the name of the secret.
  858. func (a *Agent) CreateImagePullSecrets(
  859. repo repository.Repository,
  860. namespace string,
  861. linkedRegs map[string]*models.Registry,
  862. doAuth *oauth2.Config,
  863. ) (map[string]string, error) {
  864. res := make(map[string]string)
  865. for key, val := range linkedRegs {
  866. _reg := registry.Registry(*val)
  867. data, err := _reg.GetDockerConfigJSON(repo, doAuth)
  868. if err != nil {
  869. return nil, err
  870. }
  871. secretName := fmt.Sprintf("porter-%s-%d", val.ToRegistryType().Service, val.ID)
  872. secret, err := a.Clientset.CoreV1().Secrets(namespace).Get(
  873. context.TODO(),
  874. secretName,
  875. metav1.GetOptions{},
  876. )
  877. // if not found, create the secret
  878. if err != nil && errors.IsNotFound(err) {
  879. _, err = a.Clientset.CoreV1().Secrets(namespace).Create(
  880. context.TODO(),
  881. &v1.Secret{
  882. ObjectMeta: metav1.ObjectMeta{
  883. Name: secretName,
  884. },
  885. Data: map[string][]byte{
  886. string(v1.DockerConfigJsonKey): data,
  887. },
  888. Type: v1.SecretTypeDockerConfigJson,
  889. },
  890. metav1.CreateOptions{},
  891. )
  892. if err != nil {
  893. return nil, err
  894. }
  895. // add secret name to the map
  896. res[key] = secretName
  897. continue
  898. } else if err != nil {
  899. return nil, err
  900. }
  901. // otherwise, check that the secret contains the correct data: if
  902. // if doesn't, update it
  903. if !bytes.Equal(secret.Data[v1.DockerConfigJsonKey], data) {
  904. _, err := a.Clientset.CoreV1().Secrets(namespace).Update(
  905. context.TODO(),
  906. &v1.Secret{
  907. ObjectMeta: metav1.ObjectMeta{
  908. Name: secretName,
  909. },
  910. Data: map[string][]byte{
  911. string(v1.DockerConfigJsonKey): data,
  912. },
  913. Type: v1.SecretTypeDockerConfigJson,
  914. },
  915. metav1.UpdateOptions{},
  916. )
  917. if err != nil {
  918. return nil, err
  919. }
  920. }
  921. // add secret name to the map
  922. res[key] = secretName
  923. }
  924. return res, nil
  925. }
  926. // helper that waits for pod to be ready
  927. func (a *Agent) waitForPod(pod *v1.Pod) (error, bool) {
  928. var (
  929. w watch.Interface
  930. err error
  931. ok bool
  932. )
  933. // immediately after creating a pod, the API may return a 404. heuristically 1
  934. // second seems to be plenty.
  935. watchRetries := 3
  936. for i := 0; i < watchRetries; i++ {
  937. selector := fields.OneTermEqualSelector("metadata.name", pod.Name).String()
  938. w, err = a.Clientset.CoreV1().
  939. Pods(pod.Namespace).
  940. Watch(context.Background(), metav1.ListOptions{FieldSelector: selector})
  941. if err == nil {
  942. break
  943. }
  944. time.Sleep(time.Second)
  945. }
  946. if err != nil {
  947. return err, false
  948. }
  949. defer w.Stop()
  950. for {
  951. select {
  952. case <-time.After(time.Second * 30):
  953. return goerrors.New("timed out waiting for pod"), false
  954. case <-time.Tick(time.Second):
  955. // poll every second in case we already missed the ready event while
  956. // creating the listener.
  957. pod, err = a.Clientset.CoreV1().
  958. Pods(pod.Namespace).
  959. Get(context.Background(), pod.Name, metav1.GetOptions{})
  960. if err != nil && errors.IsNotFound(err) {
  961. return IsNotFoundError, false
  962. } else if err != nil {
  963. return err, false
  964. }
  965. if isExited := isPodExited(pod); isExited || isPodReady(pod) {
  966. return nil, isExited
  967. }
  968. case evt := <-w.ResultChan():
  969. pod, ok = evt.Object.(*v1.Pod)
  970. if !ok {
  971. return fmt.Errorf("unexpected object type: %T", evt.Object), false
  972. }
  973. if isExited := isPodExited(pod); isExited || isPodReady(pod) {
  974. return nil, isExited
  975. }
  976. }
  977. }
  978. }
  979. func isPodReady(pod *v1.Pod) bool {
  980. ready := false
  981. conditions := pod.Status.Conditions
  982. for i := range conditions {
  983. if conditions[i].Type == v1.PodReady {
  984. ready = pod.Status.Conditions[i].Status == v1.ConditionTrue
  985. }
  986. }
  987. return ready
  988. }
  989. func isPodExited(pod *v1.Pod) bool {
  990. return pod.Status.Phase == v1.PodSucceeded || pod.Status.Phase == v1.PodFailed
  991. }