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

Revising matchable resource documentation #257

Merged
merged 10 commits into from
Apr 16, 2020
Merged

Conversation

wild-endeavor
Copy link
Contributor

@wild-endeavor wild-endeavor commented Apr 12, 2020

When first working with the matchable resource and configuration endpoints I was a little confused. This is my attempt to alleviate the confusion another newcomer may have with this topic.

As an example to point to in the documentation, this also adds the K8s namespace resourcequota construct to the sandbox deployment. The default settings given are:

        production:
          - projectQuotaCpu:
              value: "5"
          - projectQuotaMemory:
              value: "4000Mi"
        staging:
          - projectQuotaCpu:
              value: "1"
          - projectQuotaMemory:
              value: "2000Mi"
        development:
          - projectQuotaCpu:
              value: "1"
          - projectQuotaMemory:
              value: "2000Mi"

These are intentionally pretty low but should be sufficient to run the examples we have.

@@ -16,6 +16,7 @@ configMapGenerator:
files:
# Files are read in alphabetical order. To ensure that we create the namespace first, prefix the file name with "aa".
- clusterresource-templates/aa_namespace.yaml
- clusterresource-templates/ab_project-resource-quota.yaml
Copy link
Contributor

@katrogan katrogan Apr 16, 2020

Choose a reason for hiding this comment

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

nit: doesn't need the ab_ we just do that so that namespaces get created first (golang reads the files in alphabetically)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm... when these are done as config maps then, what order are they run in?

Copy link
Contributor

Choose a reason for hiding this comment

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

the config maps are mounted as files here, no?


In the absence of custom override values, templateData from the `flyteadmin config <https://github.com/lyft/flyteadmin/blob/6a64f00315f8ffeb0472ae96cbc2031b338c5840/flyteadmin_config.yaml#L154,L159>`_ is used as a default.
Note that these settings can only take on domain, or a project and domain specificity. Project & domain together in Flyte form Kubernetes namespaces. Since Flyte has not tied in the notion of a workflow or a launch plan to any Kubernetes constructs, specifying a workflow or launch plan name doesn't make any sense.
Copy link
Contributor

@katrogan katrogan Apr 16, 2020

Choose a reason for hiding this comment

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

Project & domain together in Flyte form Kubernetes namespaces.

this is not always true - this is now configurable (e.g. for the L5 use case namespaces are now domain only)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That is a good point, let me remove that.


All other inbound CreateExecution requests would use the default values specified in the flyteadmin config (if any).

*********
Debugging
*********

Use the `get <https://github.com/lyft/flyteidl/blob/ba13965bcfbf7e7bfce40664800aaf1f2a1088a1/protos/flyteidl/service/admin.proto#L395>`_ endpoint
Use the `get <https://github.com/lyft/flyteidl/blob/ba13965bcfbf7e7bfce40664800aaf1f2a1088a1/protos/flyteidl/service/admin.proto#L395>`__ endpoint
Copy link
Contributor

Choose a reason for hiding this comment

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

yikes, thanks for correcting all of these 🤦‍♀️

katrogan
katrogan previously approved these changes Apr 16, 2020
Copy link
Contributor

@katrogan katrogan left a comment

Choose a reason for hiding this comment

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

Thank you so much for adding all these docs!

@wild-endeavor
Copy link
Contributor Author

make end2end passes locally even though the GitHub workflow is failing, we are still in the process of investigating...

@wild-endeavor wild-endeavor merged commit 25d79e3 into master Apr 16, 2020
eapolinario pushed a commit to eapolinario/flyte that referenced this pull request Dec 6, 2022
eapolinario pushed a commit to eapolinario/flyte that referenced this pull request Dec 6, 2022
eapolinario pushed a commit to eapolinario/flyte that referenced this pull request Dec 20, 2022
* overriding OutputWriter

Signed-off-by: Daniel Rammer <[email protected]>

* updated comments

Signed-off-by: Daniel Rammer <[email protected]>

* added unit test

Signed-off-by: Daniel Rammer <[email protected]>

* fixed lint issues

Signed-off-by: Daniel Rammer <[email protected]>
eapolinario pushed a commit to eapolinario/flyte that referenced this pull request Dec 20, 2022
* Migrate register from docker to flytectl

Signed-off-by: yuvraj <[email protected]>

* Small fix

Signed-off-by: Yuvraj <[email protected]>

* added docs for flytectl in readme

Signed-off-by: Yuvraj <[email protected]>

* remove register command from conatiner

Signed-off-by: Yuvraj <[email protected]>

* use register command outside the container

Signed-off-by: Yuvraj <[email protected]>

* remove register from container makefile for all example

Signed-off-by: Yuvraj <[email protected]>

* fix typo

Signed-off-by: Yuvraj <[email protected]>

* revert conatiner change

Signed-off-by: Yuvraj <[email protected]>
eapolinario pushed a commit to eapolinario/flyte that referenced this pull request Dec 20, 2022
* Revert "Migrate register from docker to flytectl (flyteorg#257)"

This reverts commit 1d2f279.
eapolinario pushed a commit to eapolinario/flyte that referenced this pull request Dec 20, 2022
* Adding flytectl.rst to index

Signed-off-by: Prafulla Mahindrakar <[email protected]>

* Update index.rst

Co-authored-by: Niels Bantilan <[email protected]>
eapolinario pushed a commit to eapolinario/flyte that referenced this pull request Dec 20, 2022
Signed-off-by: Pianist038801 <[email protected]>
Co-authored-by: Pianist038801 <[email protected]>
eapolinario pushed a commit to eapolinario/flyte that referenced this pull request Aug 9, 2023
eapolinario pushed a commit to eapolinario/flyte that referenced this pull request Aug 21, 2023
eapolinario pushed a commit to eapolinario/flyte that referenced this pull request Aug 21, 2023
* overriding OutputWriter

Signed-off-by: Daniel Rammer <[email protected]>

* updated comments

Signed-off-by: Daniel Rammer <[email protected]>

* added unit test

Signed-off-by: Daniel Rammer <[email protected]>

* fixed lint issues

Signed-off-by: Daniel Rammer <[email protected]>
eapolinario pushed a commit to eapolinario/flyte that referenced this pull request Apr 30, 2024
* Adding flytectl.rst to index

Signed-off-by: Prafulla Mahindrakar <[email protected]>

* Update index.rst

Co-authored-by: Niels Bantilan <[email protected]>
austin362667 pushed a commit to austin362667/flyte that referenced this pull request May 7, 2024
* Adding flytectl.rst to index

Signed-off-by: Prafulla Mahindrakar <[email protected]>

* Update index.rst

Co-authored-by: Niels Bantilan <[email protected]>
robert-ulbrich-mercedes-benz pushed a commit to robert-ulbrich-mercedes-benz/flyte that referenced this pull request Jul 2, 2024
* Adding flytectl.rst to index

Signed-off-by: Prafulla Mahindrakar <[email protected]>

* Update index.rst

Co-authored-by: Niels Bantilan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants