-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[POA-1445] Add terraform container snippet in kube command (#22)
_ps: This is an incremental PR into `mudit/POA-1443`_ In this PR, we are adding support for printing the Terraform resource container snippet using the `kube` command. Changes done: * Create a new `tf-sidecar-snippet` sub-command under `kube`. * Using Terraform's HCL Golang SDK to construct the resource definition * A new function, `createTerraformContainer()` which creates a HCL resource config ACC to our requirement and finally prints this config @mgritter Is this approach okay, or do you suggest to use `text/template`. Just like we are doing for k8s secret snippet?
- Loading branch information
1 parent
2f0bf5e
commit 0567bde
Showing
7 changed files
with
195 additions
and
225 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| package kube | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/postmanlabs/postman-insights-agent/cfg" | ||
| "github.com/postmanlabs/postman-insights-agent/cmd/internal/cmderr" | ||
| "github.com/postmanlabs/postman-insights-agent/rest" | ||
| v1 "k8s.io/api/core/v1" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "github.com/zclconf/go-cty/cty" | ||
| "sigs.k8s.io/yaml" | ||
|
|
||
| "github.com/hashicorp/hcl/v2/hclsyntax" | ||
| "github.com/hashicorp/hcl/v2/hclwrite" | ||
| ) | ||
|
|
||
| var printHelmChartFragmentCmd = &cobra.Command{ | ||
| Use: "helm-fragment", | ||
| Short: "Print a Helm chart container definition for adding the Postman Insights Agent to existing kubernetes deployment.", | ||
| Long: "Print a container definition that can be inserted into a Helm Chart template to add the Postman Insights Agent as a sidecar container.", | ||
| RunE: printHelmChartFragment, | ||
| PersistentPreRun: kubeCommandPreRun, | ||
| } | ||
|
|
||
| var printTerraformFragmentCmd = &cobra.Command{ | ||
| Use: "tf-fragment", | ||
| Short: "Print an Terraform (HCL) code fragment for adding the Postman Insights Agent to an existing kubernetes deployment.", | ||
| Long: "Print a Terraform (HCL) code fragment that can be inserted into a Terraform kubernetes_deployment resource spec to add the Postman Insights Agent as a sidecar container.", | ||
| RunE: printTerraformFragment, | ||
| PersistentPreRun: kubeCommandPreRun, | ||
| } | ||
|
|
||
| func printHelmChartFragment(_ *cobra.Command, _ []string) error { | ||
| err := cmderr.CheckAPIKeyAndInsightsProjectID(insightsProjectID) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Create the Postman Insights Agent sidecar container | ||
| container := createPostmanSidecar(insightsProjectID, false) | ||
| // Store it in an array since the fragment will be added to a list of containers | ||
| containerArray := []v1.Container{container} | ||
|
|
||
| containerYamlBytes, err := yaml.Marshal(containerArray) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| containerYaml := indentCodeFragment(containerYamlBytes, 4) | ||
|
|
||
| fmt.Printf("\n%s\n", containerYaml) | ||
| return nil | ||
| } | ||
|
|
||
| func printTerraformFragment(_ *cobra.Command, _ []string) error { | ||
| err := cmderr.CheckAPIKeyAndInsightsProjectID(insightsProjectID) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Create the Postman Insights Agent sidecar container | ||
| hclBlockConfig := createTerraformContainer(insightsProjectID) | ||
| hclBlockConfigString := indentCodeFragment(hclBlockConfig.Bytes(), 4) | ||
|
|
||
| // Print the fragment | ||
| fmt.Printf("\n%s\n", hclBlockConfigString) | ||
| return nil | ||
| } | ||
|
|
||
| func createTerraformContainer(insightsProjectID string) *hclwrite.File { | ||
| hclConfig := hclwrite.NewEmptyFile() | ||
| rootBody := hclConfig.Body() | ||
|
|
||
| rootBody.AppendUnstructuredTokens(hclwrite.Tokens{ | ||
| { | ||
| Type: hclsyntax.TokenComment, | ||
| Bytes: []byte("# Add this fragment to your 'kubernetes_deployment' resource under 'spec.template.spec'. \n"), | ||
| }, | ||
| }) | ||
|
|
||
| containerBlock := rootBody.AppendNewBlock("container", []string{}) | ||
| containerBody := containerBlock.Body() | ||
|
|
||
| containerBody.SetAttributeValue("name", cty.StringVal("postman-insights-agent")) | ||
| containerBody.SetAttributeValue("image", cty.StringVal(akitaImage)) | ||
|
|
||
| containerBody.AppendNewBlock("lifecycle", []string{}). | ||
| Body().AppendNewBlock("pre_stop", []string{}). | ||
| Body().AppendNewBlock("exec", []string{}). | ||
| Body().SetAttributeValue("command", cty.ListVal([]cty.Value{ | ||
| cty.StringVal("/bin/sh"), | ||
| cty.StringVal("-c"), | ||
| cty.StringVal("POSTMAN_INSIGHTS_AGENT_PID=$(pgrep postman-insights-agent) && kill -2 $POSTMAN_INSIGHTS_AGENT_PID && tail -f /proc/$POSTMAN_INSIGHTS_AGENT_PID/fd/1"), | ||
| })) | ||
|
|
||
| containerBody.AppendNewBlock("security_context", []string{}). | ||
| Body().AppendNewBlock("capabilities", []string{}). | ||
| Body().SetAttributeValue("add", cty.ListVal([]cty.Value{ | ||
| cty.StringVal("NET_RAW"), | ||
| })) | ||
|
|
||
| // Add the args to the container | ||
| args := cty.ListVal([]cty.Value{ | ||
| cty.StringVal("apidump"), | ||
| cty.StringVal("--project"), | ||
| cty.StringVal(insightsProjectID), | ||
| }) | ||
| // If a nondefault --domain flag was used, specify it for the container as well. | ||
| if rest.Domain != rest.DefaultDomain() { | ||
| args.Add(cty.StringVal("--domain")) | ||
| args.Add(cty.StringVal(rest.Domain)) | ||
| } | ||
| containerBody.SetAttributeValue("args", args) | ||
|
|
||
| // Add the environment variables to the container | ||
| pmKey, pmEnv := cfg.GetPostmanAPIKeyAndEnvironment() | ||
| APIKeyEnvBlockBody := containerBody.AppendNewBlock("env", []string{}).Body() | ||
| APIKeyEnvBlockBody.SetAttributeValue("name", cty.StringVal("POSTMAN_API_KEY")) | ||
| APIKeyEnvBlockBody.SetAttributeValue("value", cty.StringVal(pmKey)) | ||
|
|
||
| if pmEnv != "" { | ||
| PostmanEnvBlockBody := containerBody.AppendNewBlock("env", []string{}).Body() | ||
| PostmanEnvBlockBody.SetAttributeValue("name", cty.StringVal("POSTMAN_ENV")) | ||
| PostmanEnvBlockBody.SetAttributeValue("value", cty.StringVal(pmEnv)) | ||
| } | ||
|
|
||
| return hclConfig | ||
| } | ||
|
|
||
| func indentCodeFragment(codeFragmentInBytes []byte, indentLevel int) string { | ||
| // Trim off any extraneous newlines. | ||
| codeFragmentInBytes = bytes.Trim(codeFragmentInBytes, "\n") | ||
|
|
||
| // Indent level prefix | ||
| indentPrefix := strings.Repeat(" ", indentLevel) | ||
|
|
||
| indentedCodeFragment := indentPrefix + strings.ReplaceAll( | ||
| string(codeFragmentInBytes), "\n", "\n"+indentPrefix) | ||
|
|
||
| return indentedCodeFragment | ||
| } | ||
|
|
||
| func init() { | ||
| Cmd.AddCommand(printHelmChartFragmentCmd) | ||
| Cmd.AddCommand(printTerraformFragmentCmd) | ||
| } |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.