search

opendatahub-io / architecture-decision-records

Collection of Architectural Decision Records
Apache License 2.0
16 stars 36 forks source link

add ADR-0004 ODH Component requirements #8

Closed LaVLaS closed 11 months ago

LaVLaS commented 1 year ago

Define a set of software engineering standards that all ODH Core and Tier 1 components must meet in order to be included in Open Data Hub.

VaishnaviHire commented 1 year ago

/lgtm

gregsheremeta commented 1 year ago

In the past it has happened that we introduced a new component and weren't careful enough about reviewing the Kubernetes resource requests that the component made. This caused the component to be too heavyweight and clog up the cluster.

I'm trying to figure out where we could add some requirements for resource request validation testing. Something where we could prove that we're requesting the absolute minimum number of resources (CPU, memory) from the cluster such that the component still works.

Does this ADR make sense as a place to put something like that?

LaVLaS commented 1 year ago

In the past it has happened that we introduced a new component and weren't careful enough about reviewing the Kubernetes resource requests that the component made. This caused the component to be too heavyweight and clog up the cluster.

I'm trying to figure out where we could add some requirements for resource request validation testing. Something where we could prove that we're requesting the absolute minimum number of resources (CPU, memory) from the cluster such that the component still works.

Does this ADR make sense as a place to put something like that?

That is a good point about the component k8s resource requirements. I wanted to keep the scope of this ADR focused on software agnostic requirements GitHub settings but that is definitely something we wanted to formalize in another ADR document. See https://github.com/opendatahub-io/opendatahub.io/issues/68 as a reference to documenting resource requirements for ODH and it's components

accorvin commented 1 year ago

/approve

VaishnaviHire commented 1 year ago

@LaVLaS Should adding a requirement to be compatible for required kustomize version be part of this ADR?

For e.g current kustomize version is v5, whereas most components are compatible only till v3 of kustomize

LaVLaS commented 11 months ago

Closing due to inactivity and changes to the issue tracking workflow