agent.go 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196
  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. "strconv"
  13. "strings"
  14. "sync"
  15. "time"
  16. goerrors "errors"
  17. "github.com/porter-dev/porter/api/server/shared/websocket"
  18. "github.com/porter-dev/porter/cli/cmd/utils"
  19. "github.com/porter-dev/porter/internal/models"
  20. "github.com/porter-dev/porter/internal/registry"
  21. "github.com/porter-dev/porter/internal/repository"
  22. "golang.org/x/oauth2"
  23. "github.com/porter-dev/porter/internal/helm/grapher"
  24. appsv1 "k8s.io/api/apps/v1"
  25. batchv1 "k8s.io/api/batch/v1"
  26. v1 "k8s.io/api/core/v1"
  27. v1beta1 "k8s.io/api/extensions/v1beta1"
  28. netv1 "k8s.io/api/networking/v1"
  29. netv1beta1 "k8s.io/api/networking/v1beta1"
  30. "k8s.io/apimachinery/pkg/api/errors"
  31. "k8s.io/apimachinery/pkg/api/resource"
  32. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  33. "k8s.io/apimachinery/pkg/fields"
  34. "k8s.io/apimachinery/pkg/runtime"
  35. "k8s.io/apimachinery/pkg/runtime/schema"
  36. "k8s.io/apimachinery/pkg/types"
  37. "k8s.io/apimachinery/pkg/watch"
  38. "k8s.io/cli-runtime/pkg/genericclioptions"
  39. "k8s.io/client-go/informers"
  40. "k8s.io/client-go/kubernetes"
  41. "k8s.io/client-go/rest"
  42. "k8s.io/client-go/tools/cache"
  43. "k8s.io/client-go/tools/remotecommand"
  44. "k8s.io/kubectl/pkg/scheme"
  45. rspb "github.com/stefanmcshane/helm/pkg/release"
  46. istiov1beta1 "istio.io/client-go/pkg/apis/networking/v1beta1"
  47. versionedclient "istio.io/client-go/pkg/clientset/versioned"
  48. )
  49. // Agent is a Kubernetes agent for performing operations that interact with the
  50. // api server. Do not create this struct directly, use NewKubernetesAgent instead.
  51. type Agent struct {
  52. RESTClientGetter genericclioptions.RESTClientGetter
  53. Clientset kubernetes.Interface
  54. // context is used here as a workaround since RESTClientGetter and kubernetes.Interface do not support contexts
  55. context context.Context
  56. }
  57. type Message struct {
  58. EventType string `json:"event_type"`
  59. Object interface{}
  60. Kind string
  61. }
  62. type ListOptions struct {
  63. FieldSelector string
  64. }
  65. type AuthError struct{}
  66. func (e *AuthError) Error() string {
  67. return "Unauthorized error"
  68. }
  69. // NewKubernetesAgent creates a new agent for accessing kubernetes on a cluster
  70. func NewKubernetesAgent(ctx context.Context, restClientGetter genericclioptions.RESTClientGetter, clientset kubernetes.Interface) Agent {
  71. return Agent{
  72. RESTClientGetter: restClientGetter,
  73. Clientset: clientset,
  74. context: ctx,
  75. }
  76. }
  77. // UpdateClientset updates the Agent's Clientset (this refreshes auth tokens)
  78. func (a *Agent) UpdateClientset() error {
  79. restConf, err := a.RESTClientGetter.ToRESTConfig()
  80. if err != nil {
  81. return err
  82. }
  83. clientset, err := kubernetes.NewForConfig(restConf)
  84. if err != nil {
  85. return err
  86. }
  87. a.Clientset = clientset
  88. return nil
  89. }
  90. // CreateConfigMap creates the configmap given the key-value pairs and namespace
  91. func (a *Agent) CreateConfigMap(name string, namespace string, configMap map[string]string) (*v1.ConfigMap, error) {
  92. return a.Clientset.CoreV1().ConfigMaps(namespace).Create(
  93. context.TODO(),
  94. &v1.ConfigMap{
  95. ObjectMeta: metav1.ObjectMeta{
  96. Name: name,
  97. Namespace: namespace,
  98. Labels: map[string]string{
  99. "porter": "true",
  100. },
  101. },
  102. Data: configMap,
  103. },
  104. metav1.CreateOptions{},
  105. )
  106. }
  107. func (a *Agent) CreateVersionedConfigMap(name, namespace string, version uint, configMap map[string]string, apps ...string) (*v1.ConfigMap, error) {
  108. return a.Clientset.CoreV1().ConfigMaps(namespace).Create(
  109. context.TODO(),
  110. &v1.ConfigMap{
  111. ObjectMeta: metav1.ObjectMeta{
  112. Name: fmt.Sprintf("%s.v%d", name, version),
  113. Namespace: namespace,
  114. Labels: map[string]string{
  115. "owner": "porter",
  116. "envgroup": name,
  117. "version": fmt.Sprintf("%d", version),
  118. },
  119. Annotations: map[string]string{
  120. PorterAppAnnotationName: strings.Join(apps, ","),
  121. },
  122. },
  123. Data: configMap,
  124. },
  125. metav1.CreateOptions{},
  126. )
  127. }
  128. const PorterAppAnnotationName = "porter.run/apps"
  129. func (a *Agent) AddApplicationToVersionedConfigMap(cm *v1.ConfigMap, appName string) (*v1.ConfigMap, error) {
  130. annons := cm.Annotations
  131. if annons == nil {
  132. annons = make(map[string]string)
  133. }
  134. appAnnon, appAnnonExists := annons[PorterAppAnnotationName]
  135. if !appAnnonExists || appAnnon == "" {
  136. annons[PorterAppAnnotationName] = appName
  137. } else {
  138. appStrArr := strings.Split(appAnnon, ",")
  139. foundApp := false
  140. for _, appStr := range appStrArr {
  141. if appStr == appName {
  142. foundApp = true
  143. }
  144. }
  145. if !foundApp {
  146. annons[PorterAppAnnotationName] = fmt.Sprintf("%s,%s", appAnnon, appName)
  147. }
  148. }
  149. cm.SetAnnotations(annons)
  150. return a.Clientset.CoreV1().ConfigMaps(cm.Namespace).Update(
  151. context.TODO(),
  152. cm,
  153. metav1.UpdateOptions{},
  154. )
  155. }
  156. func (a *Agent) RemoveApplicationFromVersionedConfigMap(cm *v1.ConfigMap, appName string) (*v1.ConfigMap, error) {
  157. annons := cm.Annotations
  158. if annons == nil {
  159. annons = make(map[string]string)
  160. }
  161. appAnn, appAnnExists := annons[PorterAppAnnotationName]
  162. if !appAnnExists {
  163. return nil, IsNotFoundError
  164. }
  165. appStrArr := strings.Split(appAnn, ",")
  166. newStrArr := make([]string, 0)
  167. for _, appStr := range appStrArr {
  168. if appStr != appName {
  169. newStrArr = append(newStrArr, appStr)
  170. }
  171. }
  172. annons[PorterAppAnnotationName] = strings.Join(newStrArr, ",")
  173. cm.SetAnnotations(annons)
  174. return a.Clientset.CoreV1().ConfigMaps(cm.Namespace).Update(
  175. context.TODO(),
  176. cm,
  177. metav1.UpdateOptions{},
  178. )
  179. }
  180. func (a *Agent) CreateLinkedVersionedSecret(name, namespace, cmName string, version uint, data map[string][]byte) (*v1.Secret, error) {
  181. return a.Clientset.CoreV1().Secrets(namespace).Create(
  182. context.TODO(),
  183. &v1.Secret{
  184. ObjectMeta: metav1.ObjectMeta{
  185. Name: fmt.Sprintf("%s.v%d", name, version),
  186. Namespace: namespace,
  187. Labels: map[string]string{
  188. "owner": "porter",
  189. "envgroup": name,
  190. "version": fmt.Sprintf("%d", version),
  191. "configmap": cmName,
  192. },
  193. },
  194. Data: data,
  195. },
  196. metav1.CreateOptions{},
  197. )
  198. }
  199. // CreateLinkedSecret creates a secret given the key-value pairs and namespace. Values are
  200. // base64 encoded
  201. func (a *Agent) CreateLinkedSecret(name, namespace, cmName string, data map[string][]byte) (*v1.Secret, error) {
  202. return a.Clientset.CoreV1().Secrets(namespace).Create(
  203. context.TODO(),
  204. &v1.Secret{
  205. ObjectMeta: metav1.ObjectMeta{
  206. Name: name,
  207. Namespace: namespace,
  208. Labels: map[string]string{
  209. "porter": "true",
  210. "configmap": cmName,
  211. },
  212. },
  213. Data: data,
  214. },
  215. metav1.CreateOptions{},
  216. )
  217. }
  218. type mergeConfigMapData struct {
  219. Data map[string]*string `json:"data"`
  220. }
  221. // UpdateConfigMap updates the configmap given its name and namespace
  222. func (a *Agent) UpdateConfigMap(name string, namespace string, configMap map[string]string) (*v1.ConfigMap, error) {
  223. cmData := make(map[string]*string)
  224. for key, val := range configMap {
  225. valCopy := val
  226. cmData[key] = &valCopy
  227. if len(val) == 0 {
  228. cmData[key] = nil
  229. }
  230. }
  231. mergeCM := &mergeConfigMapData{
  232. Data: cmData,
  233. }
  234. patchBytes, err := json.Marshal(mergeCM)
  235. if err != nil {
  236. return nil, err
  237. }
  238. return a.Clientset.CoreV1().ConfigMaps(namespace).Patch(
  239. context.Background(),
  240. name,
  241. types.MergePatchType,
  242. patchBytes,
  243. metav1.PatchOptions{},
  244. )
  245. }
  246. type mergeLinkedSecretData struct {
  247. Data map[string]*[]byte `json:"data"`
  248. }
  249. // UpdateLinkedSecret updates the secret given its name and namespace
  250. func (a *Agent) UpdateLinkedSecret(name, namespace, cmName string, data map[string][]byte) error {
  251. secretData := make(map[string]*[]byte)
  252. for key, val := range data {
  253. valCopy := val
  254. secretData[key] = &valCopy
  255. if len(val) == 0 {
  256. secretData[key] = nil
  257. }
  258. }
  259. mergeSecret := &mergeLinkedSecretData{
  260. Data: secretData,
  261. }
  262. patchBytes, err := json.Marshal(mergeSecret)
  263. if err != nil {
  264. return err
  265. }
  266. _, err = a.Clientset.CoreV1().Secrets(namespace).Patch(
  267. context.TODO(),
  268. name,
  269. types.MergePatchType,
  270. patchBytes,
  271. metav1.PatchOptions{},
  272. )
  273. return err
  274. }
  275. // DeleteConfigMap deletes the configmap given its name and namespace
  276. func (a *Agent) DeleteConfigMap(name string, namespace string) error {
  277. return a.Clientset.CoreV1().ConfigMaps(namespace).Delete(
  278. context.TODO(),
  279. name,
  280. metav1.DeleteOptions{},
  281. )
  282. }
  283. // DeleteLinkedSecret deletes the secret given its name and namespace
  284. func (a *Agent) DeleteLinkedSecret(name, namespace string) error {
  285. return a.Clientset.CoreV1().Secrets(namespace).Delete(
  286. context.TODO(),
  287. name,
  288. metav1.DeleteOptions{},
  289. )
  290. }
  291. func (a *Agent) ListVersionedConfigMaps(name string, namespace string) ([]v1.ConfigMap, error) {
  292. listResp, err := a.Clientset.CoreV1().ConfigMaps(namespace).List(
  293. context.Background(),
  294. metav1.ListOptions{
  295. LabelSelector: fmt.Sprintf("envgroup=%s", name),
  296. },
  297. )
  298. if err != nil {
  299. return nil, err
  300. }
  301. return listResp.Items, nil
  302. }
  303. func (a *Agent) DeleteVersionedConfigMap(name string, namespace string) error {
  304. return a.Clientset.CoreV1().ConfigMaps(namespace).DeleteCollection(
  305. context.Background(),
  306. metav1.DeleteOptions{},
  307. metav1.ListOptions{
  308. LabelSelector: fmt.Sprintf("envgroup=%s", name),
  309. },
  310. )
  311. }
  312. func (a *Agent) DeleteVersionedSecret(name string, namespace string) error {
  313. return a.Clientset.CoreV1().Secrets(namespace).DeleteCollection(
  314. context.Background(),
  315. metav1.DeleteOptions{},
  316. metav1.ListOptions{
  317. LabelSelector: fmt.Sprintf("envgroup=%s", name),
  318. },
  319. )
  320. }
  321. func (a *Agent) ListAllVersionedConfigMaps(namespace string) ([]v1.ConfigMap, error) {
  322. listResp, err := a.Clientset.CoreV1().ConfigMaps(namespace).List(
  323. context.Background(),
  324. metav1.ListOptions{
  325. LabelSelector: fmt.Sprintf("envgroup"),
  326. },
  327. )
  328. if err != nil {
  329. return nil, err
  330. }
  331. // only keep the latest version for each configmap
  332. latestMap := make(map[string]v1.ConfigMap)
  333. for _, configmap := range listResp.Items {
  334. egName, egNameExists := configmap.Labels["envgroup"]
  335. if !egNameExists {
  336. continue
  337. }
  338. id := fmt.Sprintf("%s/%s", configmap.Namespace, egName)
  339. if currLatest, exists := latestMap[id]; exists {
  340. // get version
  341. currVersionStr, currVersionExists := currLatest.Labels["version"]
  342. versionStr, versionExists := configmap.Labels["version"]
  343. if versionExists && currVersionExists {
  344. currVersion, currErr := strconv.Atoi(currVersionStr)
  345. version, err := strconv.Atoi(versionStr)
  346. if currErr == nil && err == nil && currVersion < version {
  347. latestMap[id] = configmap
  348. }
  349. }
  350. } else {
  351. latestMap[id] = configmap
  352. }
  353. }
  354. res := make([]v1.ConfigMap, 0)
  355. for _, cm := range latestMap {
  356. res = append(res, cm)
  357. }
  358. return res, nil
  359. }
  360. // GetConfigMap retrieves the configmap given its name and namespace
  361. func (a *Agent) GetConfigMap(name string, namespace string) (*v1.ConfigMap, error) {
  362. return a.Clientset.CoreV1().ConfigMaps(namespace).Get(
  363. context.TODO(),
  364. name,
  365. metav1.GetOptions{},
  366. )
  367. }
  368. func (a *Agent) GetVersionedConfigMap(name, namespace string, version uint) (*v1.ConfigMap, error) {
  369. listResp, err := a.Clientset.CoreV1().ConfigMaps(namespace).List(
  370. context.Background(),
  371. metav1.ListOptions{
  372. LabelSelector: fmt.Sprintf("envgroup=%s,version=%d", name, version),
  373. },
  374. )
  375. if err != nil {
  376. return nil, err
  377. }
  378. if listResp.Items == nil || len(listResp.Items) == 0 {
  379. return nil, IsNotFoundError
  380. }
  381. // if the length of the list is greater than 1, return an error -- this shouldn't happen
  382. if len(listResp.Items) > 1 {
  383. return nil, fmt.Errorf("multiple configmaps found while searching for %s/%s and version %d", namespace, name, version)
  384. }
  385. return &listResp.Items[0], nil
  386. }
  387. func (a *Agent) GetLatestVersionedConfigMap(name, namespace string) (*v1.ConfigMap, uint, error) {
  388. listResp, err := a.Clientset.CoreV1().ConfigMaps(namespace).List(
  389. context.Background(),
  390. metav1.ListOptions{
  391. LabelSelector: fmt.Sprintf("envgroup=%s", name),
  392. },
  393. )
  394. if err != nil {
  395. return nil, 0, err
  396. }
  397. if listResp.Items == nil || len(listResp.Items) == 0 {
  398. return nil, 0, IsNotFoundError
  399. }
  400. // iterate through the configmaps and get the greatest version
  401. var res *v1.ConfigMap
  402. var latestVersion uint
  403. for _, configmap := range listResp.Items {
  404. if res == nil {
  405. versionStr, versionExists := configmap.Labels["version"]
  406. if !versionExists {
  407. continue
  408. }
  409. version, err := strconv.Atoi(versionStr)
  410. if err != nil {
  411. continue
  412. }
  413. latestV := configmap
  414. res = &latestV
  415. latestVersion = uint(version)
  416. } else {
  417. // get version
  418. versionStr, versionExists := configmap.Labels["version"]
  419. currVersionStr, currVersionExists := res.Labels["version"]
  420. if versionExists && currVersionExists {
  421. currVersion, currErr := strconv.Atoi(currVersionStr)
  422. version, err := strconv.Atoi(versionStr)
  423. if currErr == nil && err == nil && currVersion < version {
  424. latestV := configmap
  425. res = &latestV
  426. latestVersion = uint(version)
  427. }
  428. }
  429. }
  430. }
  431. if res == nil {
  432. return nil, 0, IsNotFoundError
  433. }
  434. return res, latestVersion, nil
  435. }
  436. func (a *Agent) GetLatestVersionedSecret(name, namespace string) (*v1.Secret, uint, error) {
  437. listResp, err := a.Clientset.CoreV1().Secrets(namespace).List(
  438. context.Background(),
  439. metav1.ListOptions{
  440. LabelSelector: fmt.Sprintf("envgroup=%s", name),
  441. },
  442. )
  443. if err != nil {
  444. return nil, 0, err
  445. }
  446. if listResp.Items == nil || len(listResp.Items) == 0 {
  447. return nil, 0, IsNotFoundError
  448. }
  449. // iterate through the configmaps and get the greatest version
  450. var res *v1.Secret
  451. var latestVersion uint
  452. for _, secret := range listResp.Items {
  453. if res == nil {
  454. versionStr, versionExists := secret.Labels["version"]
  455. if !versionExists {
  456. continue
  457. }
  458. version, err := strconv.Atoi(versionStr)
  459. if err != nil {
  460. continue
  461. }
  462. latestV := secret
  463. res = &latestV
  464. latestVersion = uint(version)
  465. } else {
  466. // get version
  467. versionStr, versionExists := secret.Labels["version"]
  468. currVersionStr, currVersionExists := res.Labels["version"]
  469. if versionExists && currVersionExists {
  470. currVersion, currErr := strconv.Atoi(currVersionStr)
  471. version, err := strconv.Atoi(versionStr)
  472. if currErr == nil && err == nil && currVersion < version {
  473. latestV := secret
  474. res = &latestV
  475. latestVersion = uint(version)
  476. }
  477. }
  478. }
  479. }
  480. if res == nil {
  481. return nil, 0, IsNotFoundError
  482. }
  483. return res, latestVersion, nil
  484. }
  485. // GetSecret retrieves the secret given its name and namespace
  486. func (a *Agent) GetSecret(name string, namespace string) (*v1.Secret, error) {
  487. return a.Clientset.CoreV1().Secrets(namespace).Get(
  488. context.TODO(),
  489. name,
  490. metav1.GetOptions{},
  491. )
  492. }
  493. // ListConfigMaps simply lists namespaces
  494. func (a *Agent) ListConfigMaps(namespace string) (*v1.ConfigMapList, error) {
  495. return a.Clientset.CoreV1().ConfigMaps(namespace).List(
  496. context.TODO(),
  497. metav1.ListOptions{
  498. LabelSelector: "porter",
  499. },
  500. )
  501. }
  502. // ListEvents lists the events of a given object.
  503. func (a *Agent) ListEvents(name string, namespace string) (*v1.EventList, error) {
  504. return a.Clientset.CoreV1().Events(namespace).List(
  505. context.TODO(),
  506. metav1.ListOptions{
  507. FieldSelector: fmt.Sprintf("involvedObject.name=%s,involvedObject.namespace=%s", name, namespace),
  508. },
  509. )
  510. }
  511. // ListNamespaces simply lists namespaces
  512. func (a *Agent) ListNamespaces() (*v1.NamespaceList, error) {
  513. return a.Clientset.CoreV1().Namespaces().List(
  514. context.TODO(),
  515. metav1.ListOptions{},
  516. )
  517. }
  518. // CreateNamespace creates a namespace with the given name.
  519. func (a *Agent) CreateNamespace(name string, labels map[string]string) (*v1.Namespace, error) {
  520. // check if namespace exists
  521. checkNS, err := a.Clientset.CoreV1().Namespaces().Get(
  522. context.TODO(),
  523. name,
  524. metav1.GetOptions{},
  525. )
  526. if err == nil && checkNS != nil {
  527. if checkNS.Status.Phase == v1.NamespaceTerminating {
  528. // edge case for when the same namespace was previously created
  529. // but was deleted and is currently in the "Terminating" phase
  530. // let us wait for a maximum of 10 seconds
  531. timeNow := time.Now().Add(10 * time.Second)
  532. stillTerminating := true
  533. for {
  534. _, err := a.Clientset.CoreV1().Namespaces().Get(
  535. context.TODO(),
  536. name,
  537. metav1.GetOptions{},
  538. )
  539. if err != nil && errors.IsNotFound(err) {
  540. stillTerminating = false
  541. break
  542. }
  543. time.Sleep(time.Second)
  544. if time.Now().After(timeNow) {
  545. break
  546. }
  547. }
  548. if stillTerminating {
  549. // the namespace has been in the "Terminating" phase
  550. return nil, fmt.Errorf("cannot create namespace %s, stuck in \"Terminating\" phase", name)
  551. }
  552. } else {
  553. return checkNS, nil
  554. }
  555. }
  556. namespace := &v1.Namespace{
  557. ObjectMeta: metav1.ObjectMeta{
  558. Name: name,
  559. },
  560. }
  561. if len(labels) > 0 {
  562. namespace.SetLabels(labels)
  563. }
  564. return a.Clientset.CoreV1().Namespaces().Create(
  565. context.TODO(),
  566. namespace,
  567. metav1.CreateOptions{},
  568. )
  569. }
  570. // GetNamespace gets the namespace given the name
  571. func (a *Agent) GetNamespace(name string) (*v1.Namespace, error) {
  572. ns, err := a.Clientset.CoreV1().Namespaces().Get(
  573. context.Background(),
  574. name,
  575. metav1.GetOptions{},
  576. )
  577. if err != nil {
  578. return nil, err
  579. }
  580. return ns, nil
  581. }
  582. // DeleteNamespace deletes the namespace given the name.
  583. func (a *Agent) DeleteNamespace(name string) error {
  584. // check if namespace exists
  585. checkNS, err := a.Clientset.CoreV1().Namespaces().Get(
  586. context.TODO(),
  587. name,
  588. metav1.GetOptions{},
  589. )
  590. // if the namespace is not found, don't return an error.
  591. if err != nil && errors.IsNotFound(err) {
  592. return nil
  593. }
  594. // if the namespace was found but is in the "Terminating" phase
  595. // we should ignore it and not return an error
  596. if checkNS != nil && checkNS.Status.Phase == v1.NamespaceTerminating {
  597. return nil
  598. }
  599. return a.Clientset.CoreV1().Namespaces().Delete(
  600. context.TODO(),
  601. name,
  602. metav1.DeleteOptions{},
  603. )
  604. }
  605. func (a *Agent) GetPorterAgent() (*appsv1.Deployment, error) {
  606. depl, err := a.Clientset.AppsV1().Deployments("porter-agent-system").Get(
  607. context.TODO(),
  608. "porter-agent-controller-manager",
  609. metav1.GetOptions{},
  610. )
  611. if err != nil && errors.IsNotFound(err) {
  612. return nil, IsNotFoundError
  613. }
  614. return depl, err
  615. }
  616. // ListJobsByLabel lists jobs in a namespace matching a label
  617. type Label struct {
  618. Key string
  619. Val string
  620. }
  621. func (a *Agent) ListJobsByLabel(namespace string, labels ...Label) ([]batchv1.Job, error) {
  622. selectors := make([]string, 0)
  623. for _, label := range labels {
  624. selectors = append(selectors, fmt.Sprintf("%s=%s", label.Key, label.Val))
  625. }
  626. resp, err := a.Clientset.BatchV1().Jobs(namespace).List(
  627. context.TODO(),
  628. metav1.ListOptions{
  629. LabelSelector: strings.Join(selectors, ","),
  630. },
  631. )
  632. if err != nil {
  633. return nil, err
  634. }
  635. return resp.Items, nil
  636. }
  637. // StreamJobs streams a list of jobs to the websocket writer, closing the connection once all jobs have been sent
  638. func (a *Agent) StreamJobs(namespace string, selectors string, rw *websocket.WebsocketSafeReadWriter) error {
  639. run := func() error {
  640. errorchan := make(chan error)
  641. ctx, cancel := context.WithCancel(context.Background())
  642. defer cancel()
  643. var wg sync.WaitGroup
  644. var once sync.Once
  645. var err error
  646. wg.Add(2)
  647. go func() {
  648. wg.Wait()
  649. close(errorchan)
  650. }()
  651. go func() {
  652. defer func() {
  653. if r := recover(); r != nil {
  654. // TODO: add method to alert on panic
  655. return
  656. }
  657. }()
  658. // listens for websocket closing handshake
  659. defer wg.Done()
  660. for {
  661. if _, _, err := rw.ReadMessage(); err != nil {
  662. errorchan <- nil
  663. return
  664. }
  665. }
  666. }()
  667. go func() {
  668. defer func() {
  669. if r := recover(); r != nil {
  670. // TODO: add method to alert on panic
  671. return
  672. }
  673. }()
  674. // listens for websocket closing handshake
  675. defer wg.Done()
  676. continueVal := ""
  677. for {
  678. if ctx.Err() != nil {
  679. errorchan <- nil
  680. return
  681. }
  682. labelSelector := "meta.helm.sh/release-name"
  683. if selectors != "" {
  684. labelSelector = selectors
  685. }
  686. jobs, err := a.Clientset.BatchV1().Jobs(namespace).List(
  687. ctx,
  688. metav1.ListOptions{
  689. Limit: 100,
  690. Continue: continueVal,
  691. LabelSelector: labelSelector,
  692. },
  693. )
  694. if err != nil {
  695. errorchan <- err
  696. return
  697. }
  698. for _, job := range jobs.Items {
  699. err := rw.WriteJSON(job)
  700. if err != nil {
  701. errorchan <- err
  702. return
  703. }
  704. }
  705. if jobs.Continue == "" {
  706. // we have reached the end of the list of jobs
  707. break
  708. } else {
  709. // start pagination
  710. continueVal = jobs.Continue
  711. }
  712. }
  713. // at this point, we can return the status finished
  714. err := rw.WriteJSON(map[string]interface{}{
  715. "streamStatus": "finished",
  716. })
  717. errorchan <- err
  718. }()
  719. for err = range errorchan {
  720. once.Do(func() {
  721. rw.Close()
  722. cancel()
  723. })
  724. }
  725. return err
  726. }
  727. return a.RunWebsocketTask(run)
  728. }
  729. // DeleteJob deletes the job in the given name and namespace.
  730. func (a *Agent) DeleteJob(name, namespace string) error {
  731. return a.Clientset.BatchV1().Jobs(namespace).Delete(
  732. context.TODO(),
  733. name,
  734. metav1.DeleteOptions{},
  735. )
  736. }
  737. // GetJobPods lists all pods belonging to a job in a namespace
  738. func (a *Agent) GetJobPods(namespace, jobName string) ([]v1.Pod, error) {
  739. resp, err := a.Clientset.CoreV1().Pods(namespace).List(
  740. context.TODO(),
  741. metav1.ListOptions{
  742. LabelSelector: fmt.Sprintf("%s=%s", "job-name", jobName),
  743. },
  744. )
  745. if err != nil {
  746. return nil, err
  747. }
  748. return resp.Items, nil
  749. }
  750. // GetIngress gets ingress given the name and namespace
  751. func (a *Agent) GetExtensionsV1Beta1Ingress(namespace string, name string) (*v1beta1.Ingress, error) {
  752. resp, err := a.Clientset.ExtensionsV1beta1().Ingresses(namespace).Get(
  753. context.TODO(),
  754. name,
  755. metav1.GetOptions{},
  756. )
  757. if err != nil && errors.IsNotFound(err) {
  758. return nil, IsNotFoundError
  759. } else if err != nil {
  760. return nil, err
  761. }
  762. return resp, nil
  763. }
  764. func (a *Agent) GetNetworkingV1Ingress(namespace string, name string) (*netv1.Ingress, error) {
  765. resp, err := a.Clientset.NetworkingV1().Ingresses(namespace).Get(
  766. context.TODO(),
  767. name,
  768. metav1.GetOptions{},
  769. )
  770. if err != nil && errors.IsNotFound(err) {
  771. return nil, IsNotFoundError
  772. } else if err != nil {
  773. return nil, err
  774. }
  775. return resp, nil
  776. }
  777. func (a *Agent) GetNetworkingV1Beta1Ingress(namespace string, name string) (*netv1beta1.Ingress, error) {
  778. resp, err := a.Clientset.NetworkingV1beta1().Ingresses(namespace).Get(
  779. context.TODO(),
  780. name,
  781. metav1.GetOptions{},
  782. )
  783. if err != nil && errors.IsNotFound(err) {
  784. return nil, IsNotFoundError
  785. } else if err != nil {
  786. return nil, err
  787. }
  788. return resp, nil
  789. }
  790. func (a *Agent) GetIstioIngress(namespace, name string) (*istiov1beta1.Gateway, error) {
  791. restConf, err := a.RESTClientGetter.ToRESTConfig()
  792. if err != nil {
  793. return nil, err
  794. }
  795. clientset, err := versionedclient.NewForConfig(restConf)
  796. if err != nil {
  797. return nil, err
  798. }
  799. gateway, err := clientset.NetworkingV1beta1().Gateways(namespace).Get(
  800. context.Background(), name, metav1.GetOptions{},
  801. )
  802. if err != nil {
  803. return nil, err
  804. }
  805. return gateway, nil
  806. }
  807. var IsNotFoundError = fmt.Errorf("not found")
  808. type BadRequestError struct {
  809. msg string
  810. }
  811. func (e *BadRequestError) Error() string {
  812. return e.msg
  813. }
  814. // GetDeployment gets the deployment given the name and namespace
  815. func (a *Agent) GetDeployment(c grapher.Object) (*appsv1.Deployment, error) {
  816. res, err := a.Clientset.AppsV1().Deployments(c.Namespace).Get(
  817. context.TODO(),
  818. c.Name,
  819. metav1.GetOptions{},
  820. )
  821. if err != nil && errors.IsNotFound(err) {
  822. return nil, IsNotFoundError
  823. } else if err != nil {
  824. return nil, err
  825. }
  826. res.Kind = c.Kind
  827. return res, nil
  828. }
  829. // GetStatefulSet gets the statefulset given the name and namespace
  830. func (a *Agent) GetStatefulSet(c grapher.Object) (*appsv1.StatefulSet, error) {
  831. res, err := a.Clientset.AppsV1().StatefulSets(c.Namespace).Get(
  832. context.TODO(),
  833. c.Name,
  834. metav1.GetOptions{},
  835. )
  836. if err != nil && errors.IsNotFound(err) {
  837. return nil, IsNotFoundError
  838. } else if err != nil {
  839. return nil, err
  840. }
  841. res.Kind = c.Kind
  842. return res, nil
  843. }
  844. // GetReplicaSet gets the replicaset given the name and namespace
  845. func (a *Agent) GetReplicaSet(c grapher.Object) (*appsv1.ReplicaSet, error) {
  846. res, err := a.Clientset.AppsV1().ReplicaSets(c.Namespace).Get(
  847. context.TODO(),
  848. c.Name,
  849. metav1.GetOptions{},
  850. )
  851. if err != nil && errors.IsNotFound(err) {
  852. return nil, IsNotFoundError
  853. } else if err != nil {
  854. return nil, err
  855. }
  856. res.Kind = c.Kind
  857. return res, nil
  858. }
  859. // GetDaemonSet gets the daemonset by name and namespace
  860. func (a *Agent) GetDaemonSet(c grapher.Object) (*appsv1.DaemonSet, error) {
  861. res, err := a.Clientset.AppsV1().DaemonSets(c.Namespace).Get(
  862. context.TODO(),
  863. c.Name,
  864. metav1.GetOptions{},
  865. )
  866. if err != nil && errors.IsNotFound(err) {
  867. return nil, IsNotFoundError
  868. } else if err != nil {
  869. return nil, err
  870. }
  871. res.Kind = c.Kind
  872. return res, nil
  873. }
  874. // GetJob gets the job by name and namespace
  875. func (a *Agent) GetJob(c grapher.Object) (*batchv1.Job, error) {
  876. res, err := a.Clientset.BatchV1().Jobs(c.Namespace).Get(
  877. context.TODO(),
  878. c.Name,
  879. metav1.GetOptions{},
  880. )
  881. if err != nil && errors.IsNotFound(err) {
  882. return nil, IsNotFoundError
  883. } else if err != nil {
  884. return nil, err
  885. }
  886. res.Kind = c.Kind
  887. return res, nil
  888. }
  889. // GetCronJob gets the CronJob by name and namespace
  890. func (a *Agent) GetCronJob(c grapher.Object) (*batchv1.CronJob, error) {
  891. res, err := a.Clientset.BatchV1().CronJobs(c.Namespace).Get(
  892. context.TODO(),
  893. c.Name,
  894. metav1.GetOptions{},
  895. )
  896. if err != nil && errors.IsNotFound(err) {
  897. return nil, IsNotFoundError
  898. } else if err != nil {
  899. return nil, err
  900. }
  901. res.Kind = c.Kind
  902. return res, nil
  903. }
  904. // GetPodsByLabel retrieves pods with matching labels
  905. func (a *Agent) GetPodsByLabel(selector string, namespace string) (*v1.PodList, error) {
  906. // Search in all namespaces for matching pods
  907. return a.Clientset.CoreV1().Pods(namespace).List(
  908. context.TODO(),
  909. metav1.ListOptions{
  910. LabelSelector: selector,
  911. },
  912. )
  913. }
  914. // GetPodByName retrieves a single instance of pod with given name
  915. func (a *Agent) GetPodByName(name string, namespace string) (*v1.Pod, error) {
  916. // Get pod by name
  917. pod, err := a.Clientset.CoreV1().Pods(namespace).Get(
  918. context.TODO(),
  919. name,
  920. metav1.GetOptions{},
  921. )
  922. if err != nil && errors.IsNotFound(err) {
  923. return nil, IsNotFoundError
  924. }
  925. if err != nil {
  926. return nil, err
  927. }
  928. return pod, nil
  929. }
  930. // DeletePod deletes a pod by name and namespace
  931. func (a *Agent) DeletePod(namespace string, name string) error {
  932. err := a.Clientset.CoreV1().Pods(namespace).Delete(
  933. context.TODO(),
  934. name,
  935. metav1.DeleteOptions{},
  936. )
  937. if err != nil && errors.IsNotFound(err) {
  938. return IsNotFoundError
  939. }
  940. return err
  941. }
  942. // GetPodLogs streams real-time logs from a given pod.
  943. func (a *Agent) GetPodLogs(namespace string, name string, selectedContainer string, rw *websocket.WebsocketSafeReadWriter) error {
  944. // get the pod to read in the list of contains
  945. pod, err := a.Clientset.CoreV1().Pods(namespace).Get(
  946. context.Background(),
  947. name,
  948. metav1.GetOptions{},
  949. )
  950. if err != nil && errors.IsNotFound(err) {
  951. return IsNotFoundError
  952. } else if err != nil {
  953. return fmt.Errorf("Cannot get logs from pod %s: %s", name, err.Error())
  954. }
  955. // see if container is ready and able to open a stream. If not, wait for container
  956. // to be ready.
  957. err, _ = a.waitForPod(pod)
  958. if err != nil && goerrors.Is(err, IsNotFoundError) {
  959. return IsNotFoundError
  960. } else if err != nil {
  961. return fmt.Errorf("Cannot get logs from pod %s: %s", name, err.Error())
  962. }
  963. container := pod.Spec.Containers[0].Name
  964. if len(selectedContainer) > 0 {
  965. container = selectedContainer
  966. }
  967. tails := int64(400)
  968. // follow logs
  969. podLogOpts := v1.PodLogOptions{
  970. Follow: true,
  971. TailLines: &tails,
  972. Container: container,
  973. }
  974. req := a.Clientset.CoreV1().Pods(namespace).GetLogs(name, &podLogOpts)
  975. podLogs, err := req.Stream(context.TODO())
  976. // in the case of bad request errors, such as if the pod is stuck in "ContainerCreating",
  977. // we'd like to pass this through to the client.
  978. if err != nil && errors.IsBadRequest(err) {
  979. return &BadRequestError{err.Error()}
  980. } else if err != nil {
  981. return fmt.Errorf("Cannot open log stream for pod %s: %s", name, err.Error())
  982. }
  983. r := bufio.NewReader(podLogs)
  984. errorchan := make(chan error)
  985. var wg sync.WaitGroup
  986. var once sync.Once
  987. wg.Add(2)
  988. go func() {
  989. wg.Wait()
  990. close(errorchan)
  991. }()
  992. go func() {
  993. defer func() {
  994. if r := recover(); r != nil {
  995. // TODO: add method to alert on panic
  996. return
  997. }
  998. }()
  999. // listens for websocket closing handshake
  1000. defer wg.Done()
  1001. for {
  1002. if _, _, err := rw.ReadMessage(); err != nil {
  1003. errorchan <- nil
  1004. return
  1005. }
  1006. }
  1007. }()
  1008. go func() {
  1009. defer func() {
  1010. if r := recover(); r != nil {
  1011. // TODO: add method to alert on panic
  1012. return
  1013. }
  1014. }()
  1015. defer wg.Done()
  1016. for {
  1017. bytes, err := r.ReadBytes('\n')
  1018. if err != nil {
  1019. errorchan <- err
  1020. return
  1021. }
  1022. if _, writeErr := rw.Write(bytes); writeErr != nil {
  1023. errorchan <- writeErr
  1024. return
  1025. }
  1026. }
  1027. }()
  1028. for err = range errorchan {
  1029. // only call these methods a single time
  1030. once.Do(func() {
  1031. rw.Close()
  1032. podLogs.Close()
  1033. })
  1034. }
  1035. return err
  1036. }
  1037. // GetPodLogs streams real-time logs from a given pod.
  1038. func (a *Agent) GetPreviousPodLogs(namespace string, name string, selectedContainer string) ([]string, error) {
  1039. // get the pod to read in the list of contains
  1040. pod, err := a.Clientset.CoreV1().Pods(namespace).Get(
  1041. context.Background(),
  1042. name,
  1043. metav1.GetOptions{},
  1044. )
  1045. if err != nil && errors.IsNotFound(err) {
  1046. return nil, IsNotFoundError
  1047. } else if err != nil {
  1048. return nil, fmt.Errorf("Cannot get logs from pod %s: %s", name, err.Error())
  1049. }
  1050. container := pod.Spec.Containers[0].Name
  1051. if len(selectedContainer) > 0 {
  1052. container = selectedContainer
  1053. }
  1054. tails := int64(400)
  1055. // follow logs
  1056. podLogOpts := v1.PodLogOptions{
  1057. Follow: true,
  1058. TailLines: &tails,
  1059. Container: container,
  1060. Previous: true,
  1061. }
  1062. req := a.Clientset.CoreV1().Pods(namespace).GetLogs(name, &podLogOpts)
  1063. podLogs, err := req.Stream(context.TODO())
  1064. // in the case of bad request errors, such as if the pod is stuck in "ContainerCreating",
  1065. // we'd like to pass this through to the client.
  1066. if err != nil && strings.Contains(err.Error(), "not found") {
  1067. return nil, IsNotFoundError
  1068. }
  1069. if err != nil && errors.IsBadRequest(err) {
  1070. return nil, &BadRequestError{err.Error()}
  1071. } else if err != nil {
  1072. return nil, fmt.Errorf("Cannot open log stream for pod %s: %s", name, err.Error())
  1073. }
  1074. defer podLogs.Close()
  1075. r := bufio.NewReader(podLogs)
  1076. var logs []string
  1077. for {
  1078. line, err := r.ReadString('\n')
  1079. logs = append(logs, line)
  1080. if err == io.EOF {
  1081. break
  1082. } else if err != nil {
  1083. return nil, err
  1084. }
  1085. }
  1086. return logs, nil
  1087. }
  1088. // StopJobWithJobSidecar sends a termination signal to a job running with a sidecar
  1089. func (a *Agent) StopJobWithJobSidecar(namespace, name string) error {
  1090. jobPods, err := a.GetJobPods(namespace, name)
  1091. if err != nil {
  1092. return err
  1093. }
  1094. podName := jobPods[0].ObjectMeta.Name
  1095. restConf, err := a.RESTClientGetter.ToRESTConfig()
  1096. restConf.GroupVersion = &schema.GroupVersion{
  1097. Group: "api",
  1098. Version: "v1",
  1099. }
  1100. restConf.NegotiatedSerializer = runtime.NewSimpleNegotiatedSerializer(runtime.SerializerInfo{})
  1101. restClient, err := rest.RESTClientFor(restConf)
  1102. if err != nil {
  1103. return err
  1104. }
  1105. req := restClient.Post().
  1106. Resource("pods").
  1107. Name(podName).
  1108. Namespace(namespace).
  1109. SubResource("exec")
  1110. req.Param("command", "./signal.sh")
  1111. req.Param("container", "sidecar")
  1112. req.Param("stdin", "true")
  1113. req.Param("stdout", "false")
  1114. req.Param("tty", "false")
  1115. exec, err := remotecommand.NewSPDYExecutor(restConf, "POST", req.URL())
  1116. if err != nil {
  1117. return err
  1118. }
  1119. return exec.Stream(remotecommand.StreamOptions{
  1120. Tty: false,
  1121. Stdin: strings.NewReader("./signal.sh"),
  1122. })
  1123. }
  1124. // RunWebsocketTask will run a websocket task. If the websocket returns an anauthorized error, it will restart
  1125. // the task some number of times until failing
  1126. func (a *Agent) RunWebsocketTask(task func() error) error {
  1127. lastTime := int64(0)
  1128. for {
  1129. if err := a.UpdateClientset(); err != nil {
  1130. return err
  1131. }
  1132. err := task()
  1133. if err == nil {
  1134. return nil
  1135. }
  1136. if !goerrors.Is(err, &AuthError{}) {
  1137. return err
  1138. }
  1139. if time.Now().Unix()-lastTime < 60 { // don't regenerate connection if too many unauthorized errors
  1140. return err
  1141. }
  1142. lastTime = time.Now().Unix()
  1143. }
  1144. }
  1145. // StreamControllerStatus streams controller status. Supports Deployment, StatefulSet, ReplicaSet, and DaemonSet
  1146. // TODO: Support Jobs
  1147. func (a *Agent) StreamControllerStatus(kind string, selectors string, rw *websocket.WebsocketSafeReadWriter) error {
  1148. run := func() error {
  1149. // selectors is an array of max length 1. StreamControllerStatus accepts calls without the selectors argument.
  1150. // selectors argument is a single string with comma separated key=value pairs. (e.g. "app=porter,porter=true")
  1151. tweakListOptionsFunc := func(options *metav1.ListOptions) {
  1152. options.LabelSelector = selectors
  1153. }
  1154. factory := informers.NewSharedInformerFactoryWithOptions(
  1155. a.Clientset,
  1156. 0,
  1157. informers.WithTweakListOptions(tweakListOptionsFunc),
  1158. )
  1159. var informer cache.SharedInformer
  1160. // Spins up an informer depending on kind. Convert to lowercase for robustness
  1161. switch strings.ToLower(kind) {
  1162. case "deployment":
  1163. informer = factory.Apps().V1().Deployments().Informer()
  1164. case "statefulset":
  1165. informer = factory.Apps().V1().StatefulSets().Informer()
  1166. case "replicaset":
  1167. informer = factory.Apps().V1().ReplicaSets().Informer()
  1168. case "daemonset":
  1169. informer = factory.Apps().V1().DaemonSets().Informer()
  1170. case "job":
  1171. informer = factory.Batch().V1().Jobs().Informer()
  1172. case "cronjob":
  1173. informer = factory.Batch().V1beta1().CronJobs().Informer()
  1174. case "namespace":
  1175. informer = factory.Core().V1().Namespaces().Informer()
  1176. case "pod":
  1177. informer = factory.Core().V1().Pods().Informer()
  1178. }
  1179. stopper := make(chan struct{})
  1180. errorchan := make(chan error)
  1181. var wg sync.WaitGroup
  1182. var once sync.Once
  1183. var err error
  1184. wg.Add(2)
  1185. go func() {
  1186. wg.Wait()
  1187. close(errorchan)
  1188. }()
  1189. go func() {
  1190. defer func() {
  1191. if r := recover(); r != nil {
  1192. // TODO: add method to alert on panic
  1193. return
  1194. }
  1195. }()
  1196. // listens for websocket closing handshake
  1197. defer wg.Done()
  1198. for {
  1199. if _, _, err := rw.ReadMessage(); err != nil {
  1200. errorchan <- nil
  1201. return
  1202. }
  1203. }
  1204. }()
  1205. go func() {
  1206. defer func() {
  1207. if r := recover(); r != nil {
  1208. // TODO: add method to alert on panic
  1209. return
  1210. }
  1211. }()
  1212. // listens for websocket closing handshake
  1213. defer wg.Done()
  1214. informer.SetWatchErrorHandler(func(r *cache.Reflector, err error) {
  1215. if strings.HasSuffix(err.Error(), ": Unauthorized") {
  1216. errorchan <- &AuthError{}
  1217. }
  1218. })
  1219. informer.AddEventHandler(cache.ResourceEventHandlerFuncs{
  1220. UpdateFunc: func(oldObj, newObj interface{}) {
  1221. msg := Message{
  1222. EventType: "UPDATE",
  1223. Object: newObj,
  1224. Kind: strings.ToLower(kind),
  1225. }
  1226. err := rw.WriteJSON(msg)
  1227. if err != nil {
  1228. errorchan <- err
  1229. }
  1230. },
  1231. AddFunc: func(obj interface{}) {
  1232. msg := Message{
  1233. EventType: "ADD",
  1234. Object: obj,
  1235. Kind: strings.ToLower(kind),
  1236. }
  1237. err := rw.WriteJSON(msg)
  1238. if err != nil {
  1239. errorchan <- err
  1240. }
  1241. },
  1242. DeleteFunc: func(obj interface{}) {
  1243. msg := Message{
  1244. EventType: "DELETE",
  1245. Object: obj,
  1246. Kind: strings.ToLower(kind),
  1247. }
  1248. err := rw.WriteJSON(msg)
  1249. if err != nil {
  1250. errorchan <- err
  1251. }
  1252. },
  1253. })
  1254. informer.Run(stopper)
  1255. }()
  1256. for err = range errorchan {
  1257. once.Do(func() {
  1258. close(stopper)
  1259. rw.Close()
  1260. })
  1261. }
  1262. return err
  1263. }
  1264. return a.RunWebsocketTask(run)
  1265. }
  1266. var b64 = base64.StdEncoding
  1267. var magicGzip = []byte{0x1f, 0x8b, 0x08}
  1268. func decodeRelease(data string) (*rspb.Release, error) {
  1269. // base64 decode string
  1270. b, err := b64.DecodeString(data)
  1271. if err != nil {
  1272. return nil, err
  1273. }
  1274. // For backwards compatibility with releases that were stored before
  1275. // compression was introduced we skip decompression if the
  1276. // gzip magic header is not found
  1277. if bytes.Equal(b[0:3], magicGzip) {
  1278. r, err := gzip.NewReader(bytes.NewReader(b))
  1279. if err != nil {
  1280. return nil, err
  1281. }
  1282. defer r.Close()
  1283. b2, err := ioutil.ReadAll(r)
  1284. if err != nil {
  1285. return nil, err
  1286. }
  1287. b = b2
  1288. }
  1289. var rls rspb.Release
  1290. // unmarshal release object bytes
  1291. if err := json.Unmarshal(b, &rls); err != nil {
  1292. return nil, err
  1293. }
  1294. return &rls, nil
  1295. }
  1296. func contains(s []string, str string) bool {
  1297. for _, v := range s {
  1298. if v == str {
  1299. return true
  1300. }
  1301. }
  1302. return false
  1303. }
  1304. func ParseSecretToHelmRelease(secret v1.Secret, chartList []string) (*rspb.Release, bool, error) {
  1305. if secret.Type != "helm.sh/release.v1" {
  1306. return nil, true, nil
  1307. }
  1308. releaseData, ok := secret.Data["release"]
  1309. if !ok {
  1310. return nil, true, fmt.Errorf("release field not found")
  1311. }
  1312. helm_object, err := decodeRelease(string(releaseData))
  1313. if err != nil {
  1314. return nil, true, err
  1315. }
  1316. if len(chartList) > 0 && !contains(chartList, helm_object.Name) {
  1317. return nil, true, nil
  1318. }
  1319. return helm_object, false, nil
  1320. }
  1321. func (a *Agent) StreamHelmReleases(namespace string, chartList []string, selectors string, rw *websocket.WebsocketSafeReadWriter) error {
  1322. run := func() error {
  1323. tweakListOptionsFunc := func(options *metav1.ListOptions) {
  1324. options.LabelSelector = selectors
  1325. }
  1326. factory := informers.NewSharedInformerFactoryWithOptions(
  1327. a.Clientset,
  1328. 0,
  1329. informers.WithTweakListOptions(tweakListOptionsFunc),
  1330. informers.WithNamespace(namespace),
  1331. )
  1332. informer := factory.Core().V1().Secrets().Informer()
  1333. stopper := make(chan struct{})
  1334. errorchan := make(chan error)
  1335. var wg sync.WaitGroup
  1336. var once sync.Once
  1337. var err error
  1338. wg.Add(2)
  1339. go func() {
  1340. wg.Wait()
  1341. close(errorchan)
  1342. }()
  1343. go func() {
  1344. defer func() {
  1345. if r := recover(); r != nil {
  1346. // TODO: add method to alert on panic
  1347. return
  1348. }
  1349. }()
  1350. // listens for websocket closing handshake
  1351. defer wg.Done()
  1352. for {
  1353. if _, _, err := rw.ReadMessage(); err != nil {
  1354. errorchan <- nil
  1355. return
  1356. }
  1357. }
  1358. }()
  1359. go func() {
  1360. defer func() {
  1361. if r := recover(); r != nil {
  1362. // TODO: add method to alert on panic
  1363. return
  1364. }
  1365. }()
  1366. // listens for websocket closing handshake
  1367. defer wg.Done()
  1368. informer.SetWatchErrorHandler(func(r *cache.Reflector, err error) {
  1369. if strings.HasSuffix(err.Error(), ": Unauthorized") {
  1370. errorchan <- &AuthError{}
  1371. }
  1372. })
  1373. informer.AddEventHandler(cache.ResourceEventHandlerFuncs{
  1374. UpdateFunc: func(oldObj, newObj interface{}) {
  1375. secretObj, ok := newObj.(*v1.Secret)
  1376. if !ok {
  1377. errorchan <- fmt.Errorf("could not cast to secret")
  1378. return
  1379. }
  1380. helm_object, isNotHelmRelease, err := ParseSecretToHelmRelease(*secretObj, chartList)
  1381. if isNotHelmRelease && err == nil {
  1382. return
  1383. }
  1384. if err != nil {
  1385. errorchan <- err
  1386. return
  1387. }
  1388. msg := Message{
  1389. EventType: "UPDATE",
  1390. Object: helm_object,
  1391. }
  1392. rw.WriteJSON(msg)
  1393. },
  1394. AddFunc: func(obj interface{}) {
  1395. secretObj, ok := obj.(*v1.Secret)
  1396. if !ok {
  1397. errorchan <- fmt.Errorf("could not cast to secret")
  1398. return
  1399. }
  1400. helm_object, isNotHelmRelease, err := ParseSecretToHelmRelease(*secretObj, chartList)
  1401. if isNotHelmRelease && err == nil {
  1402. return
  1403. }
  1404. if err != nil {
  1405. errorchan <- err
  1406. return
  1407. }
  1408. msg := Message{
  1409. EventType: "ADD",
  1410. Object: helm_object,
  1411. }
  1412. rw.WriteJSON(msg)
  1413. },
  1414. DeleteFunc: func(obj interface{}) {
  1415. secretObj, ok := obj.(*v1.Secret)
  1416. if !ok {
  1417. errorchan <- fmt.Errorf("could not cast to secret")
  1418. return
  1419. }
  1420. helm_object, isNotHelmRelease, err := ParseSecretToHelmRelease(*secretObj, chartList)
  1421. if isNotHelmRelease && err == nil {
  1422. return
  1423. }
  1424. if err != nil {
  1425. errorchan <- err
  1426. return
  1427. }
  1428. msg := Message{
  1429. EventType: "DELETE",
  1430. Object: helm_object,
  1431. }
  1432. rw.WriteJSON(msg)
  1433. },
  1434. })
  1435. informer.Run(stopper)
  1436. }()
  1437. for err = range errorchan {
  1438. once.Do(func() {
  1439. close(stopper)
  1440. rw.Close()
  1441. })
  1442. }
  1443. return err
  1444. }
  1445. return a.RunWebsocketTask(run)
  1446. }
  1447. func (a *Agent) StreamPorterAgentLokiLog(
  1448. labels []string,
  1449. startTime string,
  1450. searchParam string,
  1451. limit uint32,
  1452. rw *websocket.WebsocketSafeReadWriter,
  1453. ) error {
  1454. run := func() error {
  1455. errorchan := make(chan error)
  1456. var wg sync.WaitGroup
  1457. var once sync.Once
  1458. var err error
  1459. wg.Add(2)
  1460. go func() {
  1461. wg.Wait()
  1462. close(errorchan)
  1463. }()
  1464. go func() {
  1465. defer func() {
  1466. if r := recover(); r != nil {
  1467. // TODO: add method to alert on panic
  1468. return
  1469. }
  1470. }()
  1471. defer wg.Done()
  1472. // listens for websocket closing handshake
  1473. for {
  1474. if _, _, err := rw.ReadMessage(); err != nil {
  1475. errorchan <- nil
  1476. return
  1477. }
  1478. }
  1479. }()
  1480. go func() {
  1481. defer func() {
  1482. if r := recover(); r != nil {
  1483. // TODO: add method to alert on panic
  1484. return
  1485. }
  1486. }()
  1487. defer wg.Done()
  1488. podList, err := a.Clientset.CoreV1().Pods("porter-agent-system").List(context.Background(), metav1.ListOptions{
  1489. LabelSelector: "control-plane=controller-manager",
  1490. })
  1491. if err != nil {
  1492. errorchan <- err
  1493. return
  1494. }
  1495. if len(podList.Items) == 0 {
  1496. errorchan <- fmt.Errorf("no porter agent pods found")
  1497. return
  1498. }
  1499. pod := podList.Items[0]
  1500. restConf, err := a.RESTClientGetter.ToRESTConfig()
  1501. if err != nil {
  1502. errorchan <- err
  1503. return
  1504. }
  1505. req := a.Clientset.CoreV1().RESTClient().
  1506. Post().
  1507. Resource("pods").
  1508. Name(pod.Name).
  1509. Namespace(pod.Namespace).
  1510. SubResource("exec")
  1511. cmd := []string{
  1512. "/porter/agent-cli",
  1513. "--start",
  1514. startTime,
  1515. }
  1516. for _, label := range labels {
  1517. cmd = append(cmd, "--label", label)
  1518. }
  1519. if searchParam != "" {
  1520. cmd = append(cmd, "--search", searchParam)
  1521. }
  1522. if limit > 0 {
  1523. cmd = append(cmd, "--limit", fmt.Sprintf("%d", limit))
  1524. }
  1525. opts := &v1.PodExecOptions{
  1526. Command: cmd,
  1527. Stdout: true,
  1528. Stderr: true,
  1529. }
  1530. req.VersionedParams(
  1531. opts,
  1532. scheme.ParameterCodec,
  1533. )
  1534. exec, err := remotecommand.NewSPDYExecutor(restConf, "POST", req.URL())
  1535. if err != nil {
  1536. errorchan <- err
  1537. return
  1538. }
  1539. err = exec.Stream(remotecommand.StreamOptions{
  1540. Stdin: nil,
  1541. Stdout: rw,
  1542. Stderr: rw,
  1543. })
  1544. if err != nil {
  1545. errorchan <- err
  1546. return
  1547. }
  1548. }()
  1549. for err = range errorchan {
  1550. once.Do(func() {
  1551. rw.Close()
  1552. })
  1553. }
  1554. return err
  1555. }
  1556. return a.RunWebsocketTask(run)
  1557. }
  1558. // CreateImagePullSecrets will create the required image pull secrets and
  1559. // return a map from the registry name to the name of the secret.
  1560. func (a *Agent) CreateImagePullSecrets(
  1561. repo repository.Repository,
  1562. namespace string,
  1563. linkedRegs map[string]*models.Registry,
  1564. doAuth *oauth2.Config,
  1565. ) (map[string]string, error) {
  1566. res := make(map[string]string)
  1567. for key, val := range linkedRegs {
  1568. _reg := registry.Registry(*val)
  1569. data, err := _reg.GetDockerConfigJSON(repo, doAuth)
  1570. if err != nil {
  1571. return nil, err
  1572. }
  1573. secretName := fmt.Sprintf("porter-%s-%d", val.ToRegistryType().Service, val.ID)
  1574. secret, err := a.Clientset.CoreV1().Secrets(namespace).Get(
  1575. context.TODO(),
  1576. secretName,
  1577. metav1.GetOptions{},
  1578. )
  1579. // if not found, create the secret
  1580. if err != nil && errors.IsNotFound(err) {
  1581. _, err = a.Clientset.CoreV1().Secrets(namespace).Create(
  1582. context.TODO(),
  1583. &v1.Secret{
  1584. ObjectMeta: metav1.ObjectMeta{
  1585. Name: secretName,
  1586. },
  1587. Data: map[string][]byte{
  1588. string(v1.DockerConfigJsonKey): data,
  1589. },
  1590. Type: v1.SecretTypeDockerConfigJson,
  1591. },
  1592. metav1.CreateOptions{},
  1593. )
  1594. if err != nil {
  1595. return nil, err
  1596. }
  1597. // add secret name to the map
  1598. res[key] = secretName
  1599. continue
  1600. } else if err != nil {
  1601. return nil, err
  1602. }
  1603. // otherwise, check that the secret contains the correct data: if
  1604. // if doesn't, update it
  1605. if !bytes.Equal(secret.Data[v1.DockerConfigJsonKey], data) {
  1606. _, err := a.Clientset.CoreV1().Secrets(namespace).Update(
  1607. context.TODO(),
  1608. &v1.Secret{
  1609. ObjectMeta: metav1.ObjectMeta{
  1610. Name: secretName,
  1611. },
  1612. Data: map[string][]byte{
  1613. string(v1.DockerConfigJsonKey): data,
  1614. },
  1615. Type: v1.SecretTypeDockerConfigJson,
  1616. },
  1617. metav1.UpdateOptions{},
  1618. )
  1619. if err != nil {
  1620. return nil, err
  1621. }
  1622. }
  1623. // add secret name to the map
  1624. res[key] = secretName
  1625. }
  1626. return res, nil
  1627. }
  1628. // RunCommandOnPod creates an ephemeral pod from the given pod with the given args as its start command.
  1629. func (a *Agent) RunCommandOnPod(ctx context.Context, p *v1.Pod, args []string) error {
  1630. container := p.Spec.Containers[0].Name
  1631. newPod, err := a.createEphemeralPodFromExisting(ctx, p, container, args)
  1632. if err != nil {
  1633. return err
  1634. }
  1635. podName := newPod.ObjectMeta.Name
  1636. err, _ = a.waitForPod(newPod)
  1637. if err != nil {
  1638. return err
  1639. }
  1640. // refresh pod info for latest status
  1641. newPod, err = a.Clientset.CoreV1().
  1642. Pods(newPod.Namespace).
  1643. Get(ctx, newPod.Name, metav1.GetOptions{})
  1644. if err != nil {
  1645. return err
  1646. }
  1647. req := a.Clientset.CoreV1().RESTClient().Post().
  1648. Resource("pods").
  1649. Name(podName).
  1650. Namespace(newPod.Namespace).
  1651. SubResource("attach")
  1652. req.Param("stdin", "true")
  1653. req.Param("stdout", "true")
  1654. req.Param("tty", "true")
  1655. req.Param("container", container)
  1656. restConf, err := a.RESTClientGetter.ToRESTConfig()
  1657. if err != nil {
  1658. return err
  1659. }
  1660. _, err = remotecommand.NewSPDYExecutor(restConf, "POST", req.URL())
  1661. if err != nil {
  1662. return err
  1663. }
  1664. return nil
  1665. }
  1666. // helper that waits for pod to be ready
  1667. func (a *Agent) waitForPod(pod *v1.Pod) (error, bool) {
  1668. var (
  1669. w watch.Interface
  1670. err error
  1671. ok bool
  1672. )
  1673. // immediately after creating a pod, the API may return a 404. heuristically 1
  1674. // second seems to be plenty.
  1675. watchRetries := 3
  1676. for i := 0; i < watchRetries; i++ {
  1677. selector := fields.OneTermEqualSelector("metadata.name", pod.Name).String()
  1678. w, err = a.Clientset.CoreV1().
  1679. Pods(pod.Namespace).
  1680. Watch(context.Background(), metav1.ListOptions{FieldSelector: selector})
  1681. if err == nil {
  1682. break
  1683. }
  1684. time.Sleep(time.Second)
  1685. }
  1686. if err != nil {
  1687. return err, false
  1688. }
  1689. defer w.Stop()
  1690. expireTime := time.Now().Add(time.Second * 30)
  1691. for time.Now().Unix() <= expireTime.Unix() {
  1692. select {
  1693. case <-time.NewTicker(time.Second).C:
  1694. // poll every second in case we already missed the ready event while
  1695. // creating the listener.
  1696. pod, err = a.Clientset.CoreV1().
  1697. Pods(pod.Namespace).
  1698. Get(context.Background(), pod.Name, metav1.GetOptions{})
  1699. if err != nil && errors.IsNotFound(err) {
  1700. return IsNotFoundError, false
  1701. } else if err != nil {
  1702. return err, false
  1703. }
  1704. if isExited := isPodExited(pod); isExited || isPodReady(pod) {
  1705. return nil, isExited
  1706. }
  1707. case evt := <-w.ResultChan():
  1708. pod, ok = evt.Object.(*v1.Pod)
  1709. if !ok {
  1710. return fmt.Errorf("unexpected object type: %T", evt.Object), false
  1711. }
  1712. if isExited := isPodExited(pod); isExited || isPodReady(pod) {
  1713. return nil, isExited
  1714. }
  1715. }
  1716. }
  1717. return goerrors.New("timed out waiting for pod"), false
  1718. }
  1719. func isPodReady(pod *v1.Pod) bool {
  1720. ready := false
  1721. conditions := pod.Status.Conditions
  1722. for i := range conditions {
  1723. if conditions[i].Type == v1.PodReady {
  1724. ready = pod.Status.Conditions[i].Status == v1.ConditionTrue
  1725. }
  1726. }
  1727. return ready
  1728. }
  1729. func isPodExited(pod *v1.Pod) bool {
  1730. return pod.Status.Phase == v1.PodSucceeded || pod.Status.Phase == v1.PodFailed
  1731. }
  1732. func (a *Agent) createEphemeralPodFromExisting(
  1733. ctx context.Context,
  1734. existing *v1.Pod,
  1735. container string,
  1736. args []string,
  1737. ) (*v1.Pod, error) {
  1738. newPod := existing.DeepCopy()
  1739. // only copy the pod spec, overwrite metadata
  1740. newPod.ObjectMeta = metav1.ObjectMeta{
  1741. Name: strings.ToLower(fmt.Sprintf("%s-copy-%s", existing.ObjectMeta.Name, utils.String(4))),
  1742. Namespace: existing.ObjectMeta.Namespace,
  1743. }
  1744. newPod.Status = v1.PodStatus{}
  1745. // set restart policy to never
  1746. newPod.Spec.RestartPolicy = v1.RestartPolicyNever
  1747. // change the command in the pod to the passed in pod command
  1748. cmdRoot := args[0]
  1749. cmdArgs := make([]string, 0)
  1750. // annotate with the ephemeral pod tag
  1751. newPod.Labels = make(map[string]string)
  1752. newPod.Labels["porter/ephemeral-pod"] = "true"
  1753. if len(args) > 1 {
  1754. cmdArgs = args[1:]
  1755. }
  1756. for i := 0; i < len(newPod.Spec.Containers); i++ {
  1757. if newPod.Spec.Containers[i].Name == container {
  1758. newPod.Spec.Containers[i].Command = []string{cmdRoot}
  1759. newPod.Spec.Containers[i].Args = cmdArgs
  1760. newPod.Spec.Containers[i].TTY = true
  1761. newPod.Spec.Containers[i].Stdin = true
  1762. newPod.Spec.Containers[i].StdinOnce = true
  1763. var newCpu int
  1764. if newPod.Spec.Containers[i].Resources.Requests.Cpu() != nil && newPod.Spec.Containers[i].Resources.Requests.Cpu().MilliValue() > 500 {
  1765. newCpu = 500
  1766. }
  1767. if newCpu != 0 {
  1768. newPod.Spec.Containers[i].Resources.Limits[v1.ResourceCPU] = resource.MustParse(fmt.Sprintf("%dm", newCpu))
  1769. newPod.Spec.Containers[i].Resources.Requests[v1.ResourceCPU] = resource.MustParse(fmt.Sprintf("%dm", newCpu))
  1770. for j := 0; j < len(newPod.Spec.Containers[i].Env); j++ {
  1771. if newPod.Spec.Containers[i].Env[j].Name == "PORTER_RESOURCES_CPU" {
  1772. newPod.Spec.Containers[i].Env[j].Value = fmt.Sprintf("%dm", newCpu)
  1773. break
  1774. }
  1775. }
  1776. }
  1777. var newMemory int
  1778. if newPod.Spec.Containers[i].Resources.Requests.Memory() != nil && newPod.Spec.Containers[i].Resources.Requests.Memory().Value() > 1000*1024*1024 {
  1779. newMemory = 1000
  1780. }
  1781. if newMemory != 0 {
  1782. newPod.Spec.Containers[i].Resources.Limits[v1.ResourceMemory] = resource.MustParse(fmt.Sprintf("%dMi", newMemory))
  1783. newPod.Spec.Containers[i].Resources.Requests[v1.ResourceMemory] = resource.MustParse(fmt.Sprintf("%dMi", newMemory))
  1784. for j := 0; j < len(newPod.Spec.Containers[i].Env); j++ {
  1785. if newPod.Spec.Containers[i].Env[j].Name == "PORTER_RESOURCES_RAM" {
  1786. newPod.Spec.Containers[i].Env[j].Value = fmt.Sprintf("%dMi", newMemory)
  1787. break
  1788. }
  1789. }
  1790. }
  1791. }
  1792. // remove health checks and probes
  1793. newPod.Spec.Containers[i].LivenessProbe = nil
  1794. newPod.Spec.Containers[i].ReadinessProbe = nil
  1795. newPod.Spec.Containers[i].StartupProbe = nil
  1796. }
  1797. newPod.Spec.NodeName = ""
  1798. // create the pod and return it
  1799. return a.Clientset.CoreV1().Pods(existing.ObjectMeta.Namespace).Create(
  1800. ctx,
  1801. newPod,
  1802. metav1.CreateOptions{},
  1803. )
  1804. }