Pass join token suggestedLabels to app server labels during install.sh by kimlisa · Pull Request #50720 · gravitational/teleport

kimlisa · 2025-01-03T00:11:10Z

Passes suggested labels stored from join token to app server installation

Tested, going through the add app flow, adding labels, and running download script (UI changes will be in another PR):

$ tctl get app_server
kind: app_server
metadata:
  expires: "2025-01-02T23:26:07Z"
  name: grafaana
spec:
  app:
    kind: app
    metadata:
      labels:
        apple: pie     # custom label
        hello: world   # custom label
        teleport.dev/origin: config-file
        teleport.internal/resource-id: 321a00ee-0b4f-42b8-91f7-2d67ca738ea1
      name: grafaana
    spec:
      insecure_skip_verify: false
      public_addr: grafaana.kimlisa28.cloud.gravitational.io
      uri: http://localhost:3000
    version: v3
  host_id: 5a2b4c34-997a-459e-a7ba-da9669829c07
  hostname: Lisas-MacBook-Pro.local
  proxy_ids:
  - 44f96969-6e88-4376-96b1-2b7ab1f3c183
  - 0ca0dc22-7602-40c1-82d4-2a0860cde2ac
  rotation:
    current_id: ""
    last_rotated: "0001-01-01T00:00:00Z"
    schedule:
      standby: "0001-01-01T00:00:00Z"
      update_clients: "0001-01-01T00:00:00Z"
      update_servers: "0001-01-01T00:00:00Z"
    started: "0001-01-01T00:00:00Z"
  version: 16.4.6
version: v3

web ui label rendering

zmb3 · 2025-01-03T02:02:34Z

 	var buf bytes.Buffer
 	// If app install mode is requested but parameters are blank for some reason,
 	// we need to return an error.
+	var appServerResourceLabels []string


Suggestion: move this declaration up so that the comment about app install mode stays next to the code that checks settings.appInstallMode.

Suggested change

var buf bytes.Buffer

// If app install mode is requested but parameters are blank for some reason,

// we need to return an error.

var appServerResourceLabels []string

var buf bytes.Buffer, appServerResourceLabels []string

// If app install mode is requested but parameters are blank for some reason,

// we need to return an error.

zmb3 · 2025-01-03T02:03:48Z

  - name: "${APP_NAME}"
    uri: "${APP_URI}"
    public_addr: ${APP_PUBLIC_ADDR}
+    labels:{{range $index, $line := .appServerResourceLabels}}


Do you need a conditional here to handle the case when labels is empty?

we don't have to, this is valid labels: (no values), i also tested it without adding labels to double check

Some day (🤞) I will convert this script to go (the same thing we did for Server Auto Discovery scripts), and it will be much simpler to do these things

rosstimothy · 2025-01-06T14:55:19Z

 		}
+
+		suggestedLabels := token.GetSuggestedLabels()
+		appServerResourceLabels, err = scripts.MarshalLabelsYAML(suggestedLabels, 6)


Why 6? What does it mean?

its extra space to add with yaml list, but only applies when there are multi values for a key

so if labels is only env: ['dev'] yaml string is like below and the number doesn't have any affect (like this part of the code won't run)

env: dev

but if labels is env: ['dev', 'prod'] yaml string is like below (with the extra space applied before the hyphen)

env: - dev - prod

with that said though... this number won't get used because we prevent the web UI user from adding multi values for a key (the script will error out if you let it)

marcoandredinis · 2025-01-08T11:13:59Z

  - name: "${APP_NAME}"
    uri: "${APP_URI}"
    public_addr: ${APP_PUBLIC_ADDR}
+    labels:{{range $index, $line := .appServerResourceLabels}}


Some day (🤞) I will convert this script to go (the same thing we did for Server Auto Discovery scripts), and it will be much simpler to do these things

public-teleport-github-review-bot · 2025-01-09T23:35:24Z

@kimlisa See the table below for backport results.

Branch	Result
branch/v17	Create PR

#50720) * Allow adding app server labels from join token for install.sh * Address CRs * Reduce label yaml space, improve test

* Create v2 web api endpoints and required related changes (#50472) * Pass join token suggestedLabels to app server labels during install.sh (#50720) * Allow adding app server labels from join token for install.sh * Address CRs * Reduce label yaml space, improve test * Set user provided labels for aws app access create (#50975) * Fix undefined slog

gravitational#50720) * Allow adding app server labels from join token for install.sh * Address CRs * Reduce label yaml space, improve test

kimlisa added the backport/branch/v17 label Jan 3, 2025

github-actions Bot requested review from rosstimothy and vapopov January 3, 2025 00:11

github-actions Bot added the size/sm label Jan 3, 2025

zmb3 reviewed Jan 3, 2025

View reviewed changes

rosstimothy reviewed Jan 6, 2025

View reviewed changes

kimlisa force-pushed the lisa/labels-for-app branch 2 times, most recently from 4d48a07 to 9253787 Compare January 7, 2025 07:28

kimlisa added the no-changelog Indicates that a PR does not require a changelog entry label Jan 7, 2025

kimlisa requested review from marcoandredinis and removed request for vapopov January 7, 2025 20:10

kimlisa mentioned this pull request Jan 8, 2025

WebDiscover: Allow setting labels when enrolling single web application #50853

Merged

1 task

marcoandredinis approved these changes Jan 8, 2025

View reviewed changes

rosstimothy approved these changes Jan 9, 2025

View reviewed changes

kimlisa added 3 commits January 9, 2025 14:26

Allow adding app server labels from join token for install.sh

f549e3f

Address CRs

c04edef

Reduce label yaml space, improve test

2a4e548

kimlisa force-pushed the lisa/labels-for-app branch from 9253787 to 2a4e548 Compare January 9, 2025 22:28

kimlisa enabled auto-merge January 9, 2025 22:29

Merge branch 'master' into lisa/labels-for-app

96779b2

kimlisa added this pull request to the merge queue Jan 9, 2025

Merged via the queue into master with commit 4ee850e Jan 9, 2025

kimlisa deleted the lisa/labels-for-app branch January 9, 2025 23:34

kimlisa added a commit that referenced this pull request Jan 14, 2025

Pass join token suggestedLabels to app server labels during install.sh (

f096dd7

#50720) * Allow adding app server labels from join token for install.sh * Address CRs * Reduce label yaml space, improve test

kimlisa mentioned this pull request Jan 14, 2025

[v17] v2 webapi endpoints related to discover resource labels #51037

Merged

kimlisa added a commit that referenced this pull request Jan 15, 2025

Pass join token suggestedLabels to app server labels during install.sh (

56408eb

#50720) * Allow adding app server labels from join token for install.sh * Address CRs * Reduce label yaml space, improve test

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pass join token suggestedLabels to app server labels during install.sh#50720

Pass join token suggestedLabels to app server labels during install.sh#50720
kimlisa merged 4 commits intomasterfrom
lisa/labels-for-app

kimlisa commented Jan 3, 2025 •

edited

Loading

Uh oh!

zmb3 Jan 3, 2025

Uh oh!

zmb3 Jan 3, 2025

Uh oh!

kimlisa Jan 3, 2025

Uh oh!

marcoandredinis Jan 8, 2025

Uh oh!

rosstimothy Jan 6, 2025

Uh oh!

kimlisa Jan 7, 2025

Uh oh!

Uh oh!

marcoandredinis Jan 8, 2025

Uh oh!

public-teleport-github-review-bot Bot commented Jan 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

kimlisa commented Jan 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zmb3 Jan 3, 2025

Choose a reason for hiding this comment

Uh oh!

zmb3 Jan 3, 2025

Choose a reason for hiding this comment

Uh oh!

kimlisa Jan 3, 2025

Choose a reason for hiding this comment

Uh oh!

marcoandredinis Jan 8, 2025

Choose a reason for hiding this comment

Uh oh!

rosstimothy Jan 6, 2025

Choose a reason for hiding this comment

Uh oh!

kimlisa Jan 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

marcoandredinis Jan 8, 2025

Choose a reason for hiding this comment

Uh oh!

public-teleport-github-review-bot Bot commented Jan 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kimlisa commented Jan 3, 2025 •

edited

Loading