GoogleCloudPlatform / microservices-demo

Sample cloud-first application with 10 microservices showcasing Kubernetes, Istio, and gRPC.
https://cymbal-shops.retail.cymbal.dev
Apache License 2.0
16.76k stars 7.17k forks source link

Review the Service Mesh doc #1203

Closed mathieu-benoit closed 1 year ago

mathieu-benoit commented 1 year ago

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?).

gitsan13 commented 1 year ago

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

NimJay commented 1 year ago

Hi @gitsan13, please see https://github.com/GoogleCloudPlatform/microservices-demo/issues/1428#issuecomment-1400628355.

gbrayut commented 1 year ago

@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.