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

Control API Architecture #59

Closed
wants to merge 22 commits into from
Closed

Control API Architecture #59

wants to merge 22 commits into from

Conversation

tobru
Copy link
Member

@tobru tobru commented Oct 29, 2021

This PR builds on top of:

Checklist

  • Try to isolate changes into separate PRs (to build a better changelog).
  • Categorize the PR by setting a good title and adding one of the labels:
    change, decision, requirement/quality, requirement/functional, dependency
    as they show up in the changelog

@tobru tobru mentioned this pull request Oct 29, 2021
2 tasks
@tobru tobru requested review from ccremer and corvus-ch October 29, 2021 13:45

It represents a filtered and formatted list of standard Kubernetes `Namespace` resources which have specific labels and annotations.

It is assumed that the resource `appuio.io/v1/Organization` is used for all operations (create, list, read, update, delete).
Copy link
Contributor

Choose a reason for hiding this comment

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

Are watches and patches not supported?

Suggested change
It is assumed that the resource `appuio.io/v1/Organization` is used for all operations (create, list, read, update, delete).
It is assumed that the resource `appuio.io/v1/Organization` is used for all operations (create, list, read, watch, update, patch, delete).

= {controlapi} Architecture

This page describes the xref:references/glossary.adoc#_control_api[{controlapi}].
It adheres to the decision taken in xref:explanation/decisions/control-api.adoc[{controlapi}] and it follows the features asked in xref:references/functional-requirements.adoc[Functional Requirements].
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
It adheres to the decision taken in xref:explanation/decisions/control-api.adoc[{controlapi}] and it follows the features asked in xref:references/functional-requirements.adoc[Functional Requirements].
It adheres to the decision taken in xref:explanation/decisions/control-api.adoc[{controlapi}] and it follows the features asked in xref:references/functional-requirements/portal.adoc[Portal Requirements].

@@ -0,0 +1,99 @@
= Functional Requirements
Copy link
Contributor

Choose a reason for hiding this comment

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

This page already exists in portal.adoc.
Maybe PR needs a rebase?

*** xref:appuio-cloud:ROOT:references/architecture/control-api-team.adoc[Team]
*** xref:appuio-cloud:ROOT:references/architecture/control-api-zone.adoc[Zone]

* xref:appuio-cloud:ROOT:references/functional-requirements.adoc[Functional Requirements]
Copy link
Contributor

Choose a reason for hiding this comment

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

This link is probably also outdated

@tobru
Copy link
Member Author

tobru commented Nov 3, 2021

Replaced by:

@tobru tobru closed this Nov 3, 2021
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