Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

doc: Update links in docs #4519

Merged
merged 1 commit into from
Mar 7, 2022

Conversation

allenlsy
Copy link
Contributor

@allenlsy allenlsy commented Feb 9, 2022

Description:

Update links to source code files in the OSM Components & Interactions and Design
documents.

Diagram link:

Resolves #4226

Testing done:

There is no code change.

Affected area:

Functional Area
New Functionality [ ]
CI System [ ]
CLI Tool [ ]
Certificate Management [ ]
Control Plane [ ]
Demo [ ]
Documentation [X]
Egress [ ]
Ingress [ ]
Install [ ]
Networking [ ]
Observability [ ]
Performance [ ]
SMI Policy [ ]
Security [ ]
Sidecar Injection [ ]
Tests [ ]
Upgrade [ ]
Other [ ]

Please answer the following questions with yes/no.

  1. Does this change contain code from or inspired by another project?
    • Did you notify the maintainers and provide attribution?

No

  1. Is this a breaking change?

No

  1. Has documentation corresponding to this change been updated in the osm-docs repo (if applicable)?

No

@allenlsy allenlsy marked this pull request as ready for review February 9, 2022 19:54
Copy link
Contributor

@snehachhabria snehachhabria left a comment

Choose a reason for hiding this comment

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

This doesn't resolve the issue; the diagram isn't a true representation of OSM anymore and needs to be updated. That's the requirement of the issue

docs/development_guide/osm_components_interactions.md Outdated Show resolved Hide resolved
@allenlsy allenlsy force-pushed the doc-comp-interaction branch from ad5591f to 401ca4b Compare February 10, 2022 17:34
Copy link
Contributor

@snehachhabria snehachhabria left a comment

Choose a reason for hiding this comment

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

  • The diagram is still incorrect; injector isn't a part of osm-controller anymore. osm-bootstrap is missing.
  • Integration to Vault and cert manager is missing
  • Prometheus and grafana doesn't pull metrics from application pods only, it pulls metrics from the control plane as well

These are just a few of the inconsistencies, please refer the code to get an idea of the architecture. this will help improve the diagram

@allenlsy allenlsy force-pushed the doc-comp-interaction branch from 401ca4b to 9ce92e4 Compare February 16, 2022 23:48
@allenlsy
Copy link
Contributor Author

@snehachhabria Diagram updated per feedback. PTAL.

Copy link
Contributor

@snehachhabria snehachhabria left a comment

Choose a reason for hiding this comment

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

A few suggestions on the diagram:

  • Tresor is missing as one of the cert managers
  • we can indicate that the mesh config is created from osm-bootstrap
  • osm-injector creates the sidecar on the k8s pod, this needs to be indicated

docs/development_guide/osm_components_interactions.md Outdated Show resolved Hide resolved
DESIGN.md Show resolved Hide resolved
DESIGN.md Outdated Show resolved Hide resolved
@allenlsy allenlsy force-pushed the doc-comp-interaction branch from 9ce92e4 to 4f65ef0 Compare March 2, 2022 19:35
@allenlsy allenlsy requested a review from snehachhabria March 4, 2022 17:02
DESIGN.md Outdated Show resolved Hide resolved
@shashankram
Copy link
Member

The image updates look good @allenlsy. If you used Google doc to create the image, would you mind sharing a link to the google doc hosting the image just in case we need to update it in the future? Was discussing with @trstringer about how to keep the images up to date, and we felt it would be best to use Google doc/slides to create images so we can easily edit them in the future.

Update links to source code files in the OSM Components & Interactions and Design
documents.

Signed-off-by: Allen Leigh <allenlsy@gmail.com>
@allenlsy allenlsy force-pushed the doc-comp-interaction branch from 4f65ef0 to 193d379 Compare March 4, 2022 18:33
@shashankram shashankram merged commit e972a05 into openservicemesh:main Mar 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

update osm_components_interactions.md
4 participants