Skip to content

Add design documentation#218

Merged
rootfs merged 3 commits intomainfrom
design-doc
Sep 15, 2021
Merged

Add design documentation#218
rootfs merged 3 commits intomainfrom
design-doc

Conversation

@fzdarsky
Copy link
Contributor

Signed-off-by: Frank A. Zdarsky fzdarsky@redhat.com

Signed-off-by: Frank A. Zdarsky <fzdarsky@redhat.com>
@openshift-ci openshift-ci bot requested review from copejon and oglok August 23, 2021 15:56
@screeley44
Copy link

@fzdarsky - thanks for this, my initial observation is I think it would be beneficial to have a use case/user story section as well.

Signed-off-by: Frank A. Zdarsky <fzdarsky@redhat.com>
@fzdarsky
Copy link
Contributor Author

@fzdarsky - thanks for this, my initial observation is I think it would be beneficial to have a use case/user story section as well.

That's a good idea @screeley44. I'll add those in a follow-up PR.

@mangelajo
Copy link
Contributor

@mangelajo please review %)

@oglok
Copy link
Contributor

oglok commented Sep 3, 2021

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Sep 3, 2021
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Sep 3, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: oglok

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 3, 2021
Copy link
Contributor

@mangelajo mangelajo left a comment

Choose a reason for hiding this comment

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

Some comments, great write up.

### Storage
* MicroShift defaults to local ephemeral storage (enough for basic use cases).
* Open issues / questions:
* Provide escape hatch to add own CSI (which?).
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe something like NFS is internally provided by k8s, but I will try to spin it with our current release of microshift.

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

I would need to check this works on microshift today without changes, then I can submit a follow up PR to comment on this may be?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We don't need to solve all the questions now. This is just an initial PR to document the design decisions we've made earlier and open questions we are already aware of. I'd expect this to be a living document that we add to over time as our understanding increases.

@fzdarsky fzdarsky assigned fzdarsky and unassigned oglok Sep 8, 2021
Co-authored-by: Miguel Angel Ajo Pelayo <miguelangel@ajo.es>
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Sep 8, 2021

New changes are detected. LGTM label has been removed.

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Sep 8, 2021
@rootfs rootfs merged commit b5c157a into main Sep 15, 2021
@fzdarsky fzdarsky deleted the design-doc branch September 20, 2021 10:27
sallyom pushed a commit to sallyom/microshift that referenced this pull request Nov 9, 2021
* Add design documentation

Signed-off-by: Frank A. Zdarsky <fzdarsky@redhat.com>

* Address review comments

Signed-off-by: Frank A. Zdarsky <fzdarsky@redhat.com>

* Update docs/design/design.md

Co-authored-by: Miguel Angel Ajo Pelayo <miguelangel@ajo.es>

Co-authored-by: Miguel Angel Ajo Pelayo <miguelangel@ajo.es>
fzdarsky added a commit that referenced this pull request Nov 12, 2021
* Add design documentation

Signed-off-by: Frank A. Zdarsky <fzdarsky@redhat.com>

* Address review comments

Signed-off-by: Frank A. Zdarsky <fzdarsky@redhat.com>

* Update docs/design/design.md

Co-authored-by: Miguel Angel Ajo Pelayo <miguelangel@ajo.es>

Co-authored-by: Miguel Angel Ajo Pelayo <miguelangel@ajo.es>
fzdarsky added a commit that referenced this pull request Nov 12, 2021
* Add design documentation

Signed-off-by: Frank A. Zdarsky <fzdarsky@redhat.com>

* Address review comments

Signed-off-by: Frank A. Zdarsky <fzdarsky@redhat.com>

* Update docs/design/design.md

Co-authored-by: Miguel Angel Ajo Pelayo <miguelangel@ajo.es>

Co-authored-by: Miguel Angel Ajo Pelayo <miguelangel@ajo.es>

Co-authored-by: Miguel Angel Ajo Pelayo <miguelangel@ajo.es>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants