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

Improve proxy documentation #650

Merged
merged 5 commits into from
Sep 1, 2024
Merged

Improve proxy documentation #650

merged 5 commits into from
Sep 1, 2024

Conversation

scoopex
Copy link
Contributor

@scoopex scoopex commented Jul 16, 2024

No description provided.

Signed-off-by: Marc Schöchlin <[email protected]>
@scoopex scoopex self-assigned this Jul 16, 2024
@scoopex scoopex requested a review from berendt July 16, 2024 13:18
scoopex added 3 commits July 16, 2024 16:45
Signed-off-by: Marc Schöchlin <[email protected]>
Signed-off-by: Marc Schöchlin <[email protected]>
Signed-off-by: Marc Schöchlin <[email protected]>
docs/guides/configuration-guide/proxy.md Outdated Show resolved Hide resolved
docs/guides/configuration-guide/proxy.md Outdated Show resolved Hide resolved
docs/guides/configuration-guide/proxy.md Outdated Show resolved Hide resolved
docs/guides/configuration-guide/proxy.md Outdated Show resolved Hide resolved
docs/guides/configuration-guide/proxy.md Outdated Show resolved Hide resolved
but this can also lead to higher latencies or to inferred availability problems
if the proxy is temporarily unavailable.

It usually makes sense to exclude all [private ipv4 networks](https://www.rfc-editor.org/rfc/rfc1918).
Copy link
Member

Choose a reason for hiding this comment

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

Remove this. We have a lot of scenarios where this makes no sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Interesting. Can you provide more details?

- localhost
- 127.0.0.1
- *.landscape.example.com
- "10.0.0.0/8"
Copy link
Member

Choose a reason for hiding this comment

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

Only add a sample IP range here that makes sense (e.g. the CIDR used inside the cluster).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I also listed the three 3 RFC1981 ranges in the container and kubernetes section.

The motivation for listing all private networks was, that these networks or network areas are relatively rarely accessed via a proxy anyway.

Since both Docker itself and the services operated with it tend to use HTTP communication in private networks outside the Docker network but within the OSISM environment, we avoid the OSISM user getting into trouble in so many cases because he may not have thought of all potential networks at the time of configuration.

Copy link
Member

Choose a reason for hiding this comment

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

The intend of the proxy is the use in (semi) air-gapped environments. There we only want to exclude the internal network from the proxy. Everything else has to go through the proxy.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Air-gapped environments are possible uses-cases, but I would assume that this is a rather exotic scenario.

It is probably more common for a proxy to be used for internet access because it offers the possibility to put domains on an allow list via patterns or even to use it as a caching proxy.
For security reasons, for example, you can configure the proxy to only allow the download artifacts from defined sources - e.g. this makes it more difficult for an attacker who has compromised an Openstack API service to download code from the network).

Both the nodes themselves and the networks used in Docker are RFC1918 networks. There is simply a risk that the user will not think of one or the other network or will create it later. With the proposal to generally exclude these networks, we probably avoid most of the typical problems for most users.

Due to the flexible configurability of OSISM, a more explicit configuration can be made later if necessary.

Signed-off-by: Marc Schöchlin <[email protected]>
@berendt berendt merged commit 236a436 into main Sep 1, 2024
3 checks passed
@berendt berendt deleted the proxy-settings branch September 1, 2024 18:15
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