[cloud plugin] Add serverless projectName to configuration and contract #166330
Conversation
pgayvallet
added
Team:Core
|
Pinging @elastic/kibana-core (Team:Core) |
…erless-project-name
| @@ -230,6 +230,7 @@ export default function ({ getService }: PluginFunctionalProviderContext) { | |||
| 'xpack.cloud.projects_url (any)', // It's a string (any because schema.conditional) | |||
| // can't be used to infer urls or customer id from the outside | |||
| 'xpack.cloud.serverless.project_id (string)', | |||
| 'xpack.cloud.serverless.project_name (string)', | |||
There was a problem hiding this comment.
@elastic/kibana-security I don't think this is a problem given it's only exposed on authenticated page and given we're going to expose the info in the Kibana navigation header, but still pointing this out.
There was a problem hiding this comment.
Sounds good, considering that we're already exposing project_id which is more important.
Just curious, if we ever allow user to rename the project, does it mean we'll have to restart Kibana to apply the config change? Feels a bit heavy.
There was a problem hiding this comment.
The way the project controller works, changing the name from the Cloud UI will trigger an update of the deployment, yes. But there's isn't really ways around this until Cloud exposes an API for Kibana to get the info less passively
| /** | ||
| * The serverless project name. | ||
| * Will always be present if `isServerlessEnabled` is `true` | ||
| */ | ||
| projectName?: string; |
There was a problem hiding this comment.
Technically, will only be present once the PR to inject the info from the controller is merged, but I don't think we need to have this in the comments.
| schema.object( | ||
| { | ||
| project_id: schema.string(), | ||
| project_name: schema.maybe(schema.string()), | ||
| }, | ||
| // avoid future chicken-and-egg situation with the component populating the config | ||
| { unknowns: 'ignore' } | ||
| ) |
There was a problem hiding this comment.
For future additions, this will allow to inject the data from the controller before having the version of Kibana knowing of the new setting is promoted to production
💚 Build Succeeded
Metrics [docs]Page load bundle
History
To update your PR or re-run it, just comment with: |
| @@ -230,6 +230,7 @@ export default function ({ getService }: PluginFunctionalProviderContext) { | |||
| 'xpack.cloud.projects_url (any)', // It's a string (any because schema.conditional) | |||
| // can't be used to infer urls or customer id from the outside | |||
| 'xpack.cloud.serverless.project_id (string)', | |||
| 'xpack.cloud.serverless.project_name (string)', | |||
There was a problem hiding this comment.
Sounds good, considering that we're already exposing project_id which is more important.
Just curious, if we ever allow user to rename the project, does it mean we'll have to restart Kibana to apply the config change? Feels a bit heavy.
Summary
Part of #166182
Similar to #161728
Add the
serverless.project_nameconfig setting to the cloud plugin, and expose theserverless.projectNameinfo from the cloud plugin's API.