Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Security] Reducing the metadata name of the pipelines to less than 63 chars #179580

Merged
merged 2 commits into from
Mar 28, 2024

Conversation

dkirchan
Copy link
Contributor

Backstage has a limitation of 63 chars in order to allow the resource entities to be created. Otherwise they are silently skipped.

The RREs created can be validated against: https://backstage.elastic.dev/entity-validation

This PR addresses the required name change for the pipelines to be created.

@dkirchan dkirchan added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. skip-ci v8.14.0 labels Mar 27, 2024
@dkirchan dkirchan self-assigned this Mar 27, 2024
@dkirchan dkirchan requested a review from a team as a code owner March 27, 2024 19:30
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-solution (Team: SecuritySolution)

@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • /oblt-deploy-serverless : Deploy a serverless Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@@ -2,7 +2,7 @@
apiVersion: backstage.io/v1alpha1
kind: Resource
metadata:
name: buildkite-pipeline-kibana-serverless-security-solution-quality-gate-detection-engine
name: kb-serverless-security-solution-quality-gate-detection-engine
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nuugen suggested that we do the kibana-buildkite prefix as a good practice, but it's true it's quite long/bloaty. Is there a legible alternative if we keep the kibana-buildkite, if not, I'm okay with kb-, we encode the categories in other fields anyway. @nuugen what do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kibana-buildkite with the rule of 36 chars makes the definition quite difficult.

We can either keep kb and the pipeline name as a convention OR `kibana-{abbreviation of team/org and scope}-{name}

Such as kibana-serverless-ssqg-detection-engine

What would you prefer?

@delanni delanni merged commit 7c615c5 into main Mar 28, 2024
3 of 4 checks passed
@delanni delanni deleted the fixing-backstage-compatible-rre branch March 28, 2024 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes skip-ci Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. v8.14.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants