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

📝 Add layers of fotoobo #228

Merged

Conversation

patrikspiess
Copy link
Member

closes #227

@patrikspiess patrikspiess requested a review from lucmurer October 23, 2024 07:07
Copy link
Collaborator

@lucmurer lucmurer left a comment

Choose a reason for hiding this comment

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

Great job, man! Some picky details to be fixed, otherwise I think this is a big plus for our documentation!

^^^^^^^^^^^^^^^^^^^

This is the main entry point for interaction with **fotoobo** when you installed it as an
application on your system. It acts as a frontend for users and automated tools. At the Moment only
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would use "automation tools" instead of "automated tools"

Copy link
Member Author

Choose a reason for hiding this comment

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

changed


This is the main entry point for interaction with **fotoobo** when you installed it as an
application on your system. It acts as a frontend for users and automated tools. At the Moment only
the CLI part is implemented. In future version an API may be available if there is a need for it.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would be more precise here: "a REST API", because we kinda already have an API, in Python for programmers (the "Business Logic Layer"), but it still is an API too ;-)

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, way better than just "API"

In this lowest level of **fotoobo** we directly interact with the infrastructure, meaning we handle
the authentication and API calls to the devices like FortiGate, FortiManger and others. The
interface layer should not directly access this infrastructure layer. Instead there should always
be a **tool** at the business logic layer which connects these two. No other layer than the
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it should be "a tool in the business logic layer, because "at" usually points to a physical location.

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

be a **tool** at the business logic layer which connects these two. No other layer than the
infrastructure layer should directly access any fortinet device.

As a module in you own code you may also directly use the infrastructure layer.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"in your own code"

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

Copy link
Collaborator

Choose a reason for hiding this comment

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

Two questions:

  • Do we really connect directly from the "Low Level Methods" to the devices? Otherwise I would remove the left "FortiGate". Afaik every method uses the lowest level "Native Methods" to communicate with the respective Endpoints.
  • Should we add "FortiManager / ..." to the "FortiGate", because we also communicate with them, this would imho be more clear then.

Copy link
Member Author

Choose a reason for hiding this comment

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

It was meant that only the infrastructure layer connects to the Fortinet systems. The line did not connect the methods boxes directly, but yes, the thick lines were a little misleading. I change them to thin and connect it near to the native methods.
Ans yes, would be nice to also show FortiManger and others.

@patrikspiess
Copy link
Member Author

Thanks for your suggestions!

@lucmurer lucmurer merged commit a95b207 into migros:main Oct 31, 2024
5 checks passed
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.

Add the layers of fotoobo in arch docs
2 participants