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

Review the Service Mesh doc #1203

Closed
mathieu-benoit opened this issue Oct 23, 2022 · 3 comments · Fixed by #1601
Closed

Review the Service Mesh doc #1203

mathieu-benoit opened this issue Oct 23, 2022 · 3 comments · Fixed by #1601
Assignees
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API.

Comments

@mathieu-benoit
Copy link
Contributor

mathieu-benoit commented Oct 23, 2022

The current Service Mesh doc https://github.com/GoogleCloudPlatform/microservices-demo/blob/main/docs/service-mesh.md is outdated, incomplete and misleading.

Could we have something up-to-date and more prescriptive?

For example:

  1. Setup with Istio
  2. Setup with ASM
  3. Deployment of an Ingress Gateway
  4. Deploy OB with istio-manifests

For 1., maybe showing this snippet:

gcloud services enable container.googleapis.com

gcloud container clusters create ${CLUSTER_NAME} \
    --zone ${CLUSTER_ZONE} \
    --machine-type e2-standard-4 \
    --num-nodes 4

istioctl install \
    --set profile=minimal \
    -y

For 2., maybe showing this snippet:

gcloud services enable container.googleapis.com

gcloud container clusters create ${CLUSTER_NAME} \
    --zone ${CLUSTER_ZONE} \
    --machine-type e2-standard-4 \
    --num-nodes 4 \
    --workload-pool ${PROJECT_ID}.svc.id.goog \
    --labels mesh_id=proj-${PROJECT_NUMBER}

gcloud services enable gkehub.googleapis.com

gcloud container fleet memberships register ${CLUSTER_NAME} \
    --gke-cluster ${CLUSTER_ZONE}/${CLUSTER_NAME} \
    --enable-workload-identity

gcloud services enable mesh.googleapis.com

gcloud container fleet mesh enable

gcloud container fleet mesh update \
    --management automatic \
    --memberships ${CLUSTER_NAME}

With that, OB users won't have to search everywhere to find the actual sequence of commands.

For 4., maybe a little cleanup in that folder too? For example, the allow-egress-googleapis.yaml file is not needed anymore (need to be confirmed, but someone reported me few days ago that by applying them as-is it generates errors today?).

@bourgeoisor bourgeoisor added priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API. labels Oct 23, 2022
@NimJay NimJay self-assigned this Nov 21, 2022
@mathieu-benoit mathieu-benoit added priority: p3 Desirable enhancement or fix. May not be included in next release. and removed priority: p2 Moderately-important priority. Fix may not be included in next release. labels Nov 30, 2022
@gitsan13
Copy link

Hi @mathieu-benoit
I would like to look into this issue.
Can you please assign me to it?

@NimJay
Copy link
Collaborator

NimJay commented Jan 23, 2023

Hi @gitsan13, please see #1428 (comment).

@gbrayut
Copy link
Member

gbrayut commented Feb 13, 2023

@NimJay I'll draft a PR for this per our conversation today. Feel free to assign this issue to me and I'll ping you when the PR is ready for review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants