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

Description of the installation process on gcp is not clear #2273

Closed
adamwalach opened this issue Jan 14, 2019 · 4 comments
Closed

Description of the installation process on gcp is not clear #2273

adamwalach opened this issue Jan 14, 2019 · 4 comments
Labels
area/documentation Issues or PRs related to documentation area/installation Issues or PRs related to installation duplicate This issue or pull request already exists

Comments

@adamwalach
Copy link
Contributor

adamwalach commented Jan 14, 2019

Description

In the documentation for the installation process in GCP (https://github.com/kyma-project/kyma/blob/master/docs/kyma/docs/032-inst-gke-installation.md#dns-setup) we have:

export DOMAIN={YOUR_SUBDOMAIN}
export DNS_NAME={YOUR_DOMAIN}.
export PROJECT={YOUR_GOOGLE_PROJECT}
export DNS_ZONE={YOUR_DNS_ZONE}

The value for DOMAIN is hard to guess. We suggest that this is a subdomain, but in our scripts SUBDOMAIN usually means just the prefix: https://github.com/kyma-project/test-infra/blob/master/prow/scripts/cluster-integration/kyma-gke-integration.sh#L245.
To make it easier we should provide an example:

export DOMAIN={YOUR_SUBDOMAIN} #my-kyma-cluster.example.com
export DNS_NAME={YOUR_DNS_NAME}.  #example.com.
export PROJECT={YOUR_GOOGLE_PROJECT} 
export DNS_ZONE={YOUR_DNS_ZONE} #example-com

and change DNS_NAME to YOUR_DNS_NAME.
Additionally, the DNS_ZONE "must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes", so the suggested value containing dash is needed as well.

Expected result

The description should clearly suggest what kind of value is expected

Actual result

The SUBDOMAIN may suggest that only the cluster name is required

@adamwalach adamwalach added the area/documentation Issues or PRs related to documentation label Jan 14, 2019
@lszymik lszymik added the area/installation Issues or PRs related to installation label Jan 18, 2019
@lszymik lszymik added this to the Backlog_Gopher milestone Jan 18, 2019
@adamwalach
Copy link
Contributor Author

adamwalach commented Jan 23, 2019

Now we have a similar documentation about AKS. We should align both docs. Most important changes that should be made in the GCP documentation:

  • move the section with env variables to the prerequisites section
  • change the inline placeholders like "YOUR_EMAIL" to environment variables and add description how to set it (when we have a multiline command it's easy to miss the placeholder)
  • all environment variables that are used in more than one section (step) should be mentioned in the prerequisites (it is difficult to determine what is needed to run a given command cause you have to check all previous steps - maybe a variable was set there)

@atakanyenel
Copy link

Another issue I found: installation to gke still refers to --cluster-version 1.10.7 but that cluster version is not supported by GKE. I referred to AKS installation which defines cluster-version as 1.10.9 , but that version is also not supported by GKE.

There is currently no documentation for the right parameters for a cluster in GKE.

@stale
Copy link

stale bot commented Mar 26, 2019

This issue has been automatically marked as stale due to the lack of recent activity. It will soon be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Mar 26, 2019
@lszymik lszymik added duplicate This issue or pull request already exists and removed stale labels Mar 29, 2019
@lszymik
Copy link
Contributor

lszymik commented Mar 29, 2019

It is already done.

@lszymik lszymik closed this as completed Mar 29, 2019
grischperl pushed a commit to grischperl/kyma that referenced this issue Nov 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation area/installation Issues or PRs related to installation duplicate This issue or pull request already exists
Projects
None yet
Development

No branches or pull requests

3 participants