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.

Sign up for GitHub

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

Jump to bottom

Create checklist for adding new assets to packages #27

Open
ruflin opened this issue Aug 17, 2020 · 3 comments
Open

Create checklist for adding new assets to packages #27

ruflin opened this issue Aug 17, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@ruflin
Copy link
Member

ruflin commented Aug 17, 2020 •
edited
Loading

Today packages support a basic list of assets for the Elastic Stack. Moving forward more assets like transform (#23) need to be supported. Any addition of an assets needs changes in multiple places and similar questions need to be answered. This issue is to discuss and create a checklist for adding new assets.

Here a first attempt on what needs to be checked / discussed for each asset:

  • Package spec
    • What is the format of the assets in the package
    • What is the path the assets is stored under
    • Does it support any special configuration
    • Naming of the files and supported formats (for example json vs yaml)
  • Elasticsearch Asset
    • How is the asset created?
    • Does the asset to be created require any previous assets?
    • What permissions are needed to create and manage the asset?
  • Kibana Assets
    • Is it a saved object and if yes, what is it's visibiliy? (space agnostic, shared, ...)
    • Is there anything related to the indexing strategy?
    • What permissions are needed to create and manage the asset?
  • Kibana Ingest Manager
    • What are the CRUD operations for the asset?
    • Any special behaviour on upgrade?
    • Under which name is the asset created / stored?

I filed this in the package-spec repo as it seems to be the central place where all the parts come together.
@ruflin
Copy link
Member Author

ruflin commented Aug 17, 2020

@ycombinator @ph @mtojek Would be great to get your input on the checklist and extend it.

@ph ph mentioned this issue Aug 17, 2020
Closed
@ruflin ruflin mentioned this issue Aug 19, 2020
Closed
@ycombinator ycombinator self-assigned this Nov 3, 2020
@ycombinator ycombinator added the documentation Improvements or additions to documentation label Feb 18, 2021
rw-access pushed a commit to rw-access/package-spec that referenced this issue Mar 23, 2021
@mtojek @kuisathaverat
Enable CI for the project (elastic#27)
03e0622 
* Enable CI for the project

* Remove ubuntu version

Co-authored-by: Ivan Fernandez Calvo <kuisathaverat@users.noreply.github.com>

* Fix: issueCommentTrigger

Co-authored-by: Ivan Fernandez Calvo <kuisathaverat@users.noreply.github.com>

* Remove periodic-folder-trigger

Co-authored-by: Ivan Fernandez Calvo <kuisathaverat@users.noreply.github.com>

* Remove Dockerfile

Co-authored-by: Ivan Fernandez Calvo <kuisathaverat@users.noreply.github.com>
@mtojek
Copy link
Contributor

mtojek commented Oct 12, 2021

As MVP this could be a question-answer list which you need to fill if you want to introduce a new item to spec.

@mtojek
Copy link
Contributor

mtojek commented Nov 2, 2021 •
edited
Loading

So far we know about these assets:

#29
#28
#23

Do you think we can consider this issue as a meta-issue for these tasks?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ycombinator @ruflin @mtojek