Skip to content

[AIRFLOW-XXXX] Add architecture section to k8sexec docs#7406

Merged
kaxil merged 1 commit intoapache:masterfrom
dimberman:k8s-executor-documents
Feb 21, 2020
Merged

[AIRFLOW-XXXX] Add architecture section to k8sexec docs#7406
kaxil merged 1 commit intoapache:masterfrom
dimberman:k8s-executor-documents

Conversation

@dimberman
Copy link
Contributor

@dimberman dimberman commented Feb 12, 2020


Issue link: Document only change, no JIRA issue

Make sure to mark the boxes below before creating PR: [x]

  • Description above provides context of the change
  • Commit message/PR title starts with [AIRFLOW-NNNN]. AIRFLOW-NNNN = JIRA ID*
  • Unit tests coverage for changes (not needed for documentation changes)
  • Commits follow "How to write a good git commit message"
  • Relevant documentation is updated including usage instructions.
  • I will engage committers as explained in Contribution Workflow Example.

* For document-only changes commit message can start with [AIRFLOW-XXXX].


In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.
Read the Pull Request Guidelines for more information.

@dimberman dimberman requested review from ashb and potiuk February 12, 2020 14:58
@dimberman dimberman changed the title Improve k8s executor documentation [AIRFLOW-XXX] Improve k8s executor documentation Feb 12, 2020
@dimberman dimberman force-pushed the k8s-executor-documents branch from 5488b99 to b3aa8fc Compare February 12, 2020 14:59
@dimberman dimberman changed the title [AIRFLOW-XXX] Improve k8s executor documentation [AIRFLOW-XXXX] Improve k8s executor documentation Feb 12, 2020
@dimberman dimberman changed the title [AIRFLOW-XXXX] Improve k8s executor documentation [AIRFLOW-XXXX] improve k8s executor documentation Feb 12, 2020
@dimberman dimberman force-pushed the k8s-executor-documents branch from b3aa8fc to 0a8aa7e Compare February 12, 2020 15:02
@boring-cyborg boring-cyborg bot added the area:Scheduler including HA (high availability) scheduler label Feb 12, 2020
@dimberman dimberman force-pushed the k8s-executor-documents branch from 0a8aa7e to d15a22f Compare February 12, 2020 15:04
@dimberman dimberman changed the title [AIRFLOW-XXXX] improve k8s executor documentation [AIRFLOW-XXXX] Add architecture section to k8sexec docs Feb 12, 2020
@dimberman dimberman force-pushed the k8s-executor-documents branch from d15a22f to 6e4c2ab Compare February 12, 2020 15:07
@mik-laj
Copy link
Member

mik-laj commented Feb 12, 2020

Can you add some labels to the diagram, please? The diagram uses the Airflow logo to describe many different components. It is not clear what the role of each logo is. Lines appear in the diagram, but they are not described. I think that it is also worth numbering the next steps in the diagram, which allows for easier tracking of the message. If possible, it is worth using generally accepted conventions, e.g. sequence diagram. This makes the drawings simpler to understand and easier to draw. You could use online editor e.g. https://www.planttext.com/
Example: https://github.com/apache/airflow/pull/6961/files
Old preview: https://user-images.githubusercontent.com/12058428/71550253-ebd62000-29cb-11ea-827f-d6d66cf25256.png
What do you think about Did you have any reason to draw this diagram in a graphics program? I am afraid of such diagram, because then they are difficult to edit.

I have one more comment. Can you maintain uniform naming between text and diagram also, please? You use the term "the backend DB" in the text, but it does not appear in the image, but instead is "PostgresSQL".

I also prepared preview of your documentation:
Preview: https://acceptable-goat.surge.sh/executor/kubernetes.html

@dimberman dimberman force-pushed the k8s-executor-documents branch 3 times, most recently from aec969b to 1c98154 Compare February 21, 2020 18:15
@dimberman dimberman requested review from ashb and kaxil February 21, 2020 18:15
Adds an architecture section the KubernetesExecutor documentation
@dimberman dimberman force-pushed the k8s-executor-documents branch from 1c98154 to 5190269 Compare February 21, 2020 21:26
@dimberman dimberman requested a review from kaxil February 21, 2020 22:28
@kaxil kaxil merged commit d12001a into apache:master Feb 21, 2020
@dimberman dimberman deleted the k8s-executor-documents branch February 22, 2020 19:03
galuszkak pushed a commit to FlyrInc/apache-airflow that referenced this pull request Mar 5, 2020
Adds an architecture section the KubernetesExecutor documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:Scheduler including HA (high availability) scheduler

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants