diff --git a/docs/installation-steps/DeployViaGoogleCloudMarketplace.mdx b/docs/installation-steps/DeployViaGoogleCloudMarketplace.mdx index cdf81a5e3..5032806e9 100644 --- a/docs/installation-steps/DeployViaGoogleCloudMarketplace.mdx +++ b/docs/installation-steps/DeployViaGoogleCloudMarketplace.mdx @@ -11,101 +11,133 @@ Any engineer, even those not well-versed in DevOps, can go to the Google Cloud M Next, you will find a step-by-step guide on deploying ReportPortal via the Google Cloud Marketplace. -:::note -A Cloud Billing account needs to be created beforehand. -::: +**Prerequisites** + +A [Cloud Billing account](https://cloud.google.com/billing/docs/how-to/create-billing-account) needs to be created beforehand. -**Step 1** +## Installation -[Open ReportPortal](https://console.cloud.google.com/marketplace/product/epam-mp-rp/reportportal?project=epam-mp-rp&pli=1) in Google Cloud Marketplace +### Get started - +1. [Open ReportPortal](https://console.cloud.google.com/marketplace/product/epam-mp-rp/reportportal?project=epam-mp-rp&pli=1) +in Google Cloud Marketplace. -**Step 2** + -Click ‘Get started’ button +2. Click ‘Get started’ button. - + -**Step 3** +### Initial setup of billing and API (optional) -Select a project and accept terms and agreements +:::important +These steps are executed once, provided that this is not configured. +::: - +1. Select a project and accept terms and agreements. -**Step 4** (optional) + -Enable billing and set the billing account +2. Enable billing and set the billing account. :::note You will see this screen if you have not enabled billing or set up the billing account before. ::: - + - + After that, accept terms and agreements again. -**Step 5** +3. Click ‘Deploy’ button. -Click ‘Deploy’ button + - +4. Enable API. -**Step 6** (optional) +:::note +You will see this screen if you have not enabled API before. +::: + + + +### Configure deployment -Enable API +Fill necessary fields and create cluster. By default, a cluster with three nodes is created, but once the application is installed, +the number of nodes reduces to 1. Subsequently, depending on the project's needs, the number of nodes can be increased to 5. + +There is also an option to specify the domain name to which ReportPortal will be linked. You have the ability to enable support for +an auto-generated certificate that will be linked to this domain. Subsequently, a certificate valid in all browsers will be issued. :::note -You will see this screen if you have not enabled API before. +While enabling the 'Enable GCP Managed Certificate' option, it is mandatory to specify the hostname. ::: - + -**Step 7** +### Deploy -Fill necessary fields and create cluster + - + -By default, a cluster with three nodes is created, but once the application is installed, the number of nodes reduces to 1. +### Post-installation with hostname -Subsequently, depending on the project's needs, the number of nodes can be increased to 5. +After the deployment is completed, you will be directed to a page with application information. -**Step 8** + -Start deploying +1. Next, if you have specified a hostname, you will need to navigate to your domain hosting control panel and create a record +for your hostname with the provided `IP address`. For instance, here is how you can do it in AWS Route 53: - + - +2. [Ensure](https://console.cloud.google.com/net-services/loadbalancing/advanced/sslCertificates/list) that your auto-generated certificate has the status Active.
-**Step 9** + -Log in to ReportPortal +:::note +The process of transferring the certificate from `Provisioning` to `Active` status can take up to 30 minutes. +::: + +3. Follow your hostname in a browser. -After the deployment is completed, we will land on the page with application information from which we can follow the link to log in. + -1. Click the ‘Service URL’ link. +4. On the opened Sign In page, enter 'superadmin' as the login. - +5. Enter initial password. + + + +Let's get your ReportPortal instance up! -But after clicking the 'Service URL' link, the user receives a browser warning that the connection is not private. In reality, there is no risk because you are accessing your server, launched via an IP address. +### Post-installation without hostname + +After the deployment is completed, if you did not specify a hostname, you will be directed to a page with application information. + +1. Click the `IP address` link. + + + +But after clicking the `IP address` link, the user receives a browser warning that the connection is not private. In reality, there is no risk because you are accessing your server, launched via an IP address. So why does a warning pop up? During deployment, Google Marketplace creates a Self-signed temporary certificate, which is used for data encryption. However, during the deployment process, ReportPortal is not tied to any domain, and this certificate is also not tied to any domain. Therefore, when following the link, the user receives a browser warning because the browser considers this certificate invalid as it cannot verify it. 2. For the Chrome browser, click on 'Advanced' -> then click on 'Proceed to XXXXX (unsafe)' link. - + - + 3. On the opened Sign In page, enter 'superadmin' as the login. -4. Enter initial password (this is generated automatically and can be found on the page where you click the ‘Service URL’ link). +4. Enter initial password. + + - + :::note It may take Google Kubernetes Engine a few minutes before the application becomes accessible via the link. diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step1.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace1.png similarity index 100% rename from docs/installation-steps/img/google-cloud-marketplace/Step1.png rename to docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace1.png diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step8-2.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace10.png similarity index 100% rename from docs/installation-steps/img/google-cloud-marketplace/Step8-2.png rename to docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace10.png diff --git a/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace11.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace11.png new file mode 100644 index 000000000..b68cafe78 Binary files /dev/null and b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace11.png differ diff --git a/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace12.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace12.png new file mode 100644 index 000000000..2d2a87aa6 Binary files /dev/null and b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace12.png differ diff --git a/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace13.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace13.png new file mode 100644 index 000000000..0dbce46f8 Binary files /dev/null and b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace13.png differ diff --git a/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace14.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace14.png new file mode 100644 index 000000000..57dadd505 Binary files /dev/null and b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace14.png differ diff --git a/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace15.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace15.png new file mode 100644 index 000000000..047bd92ef Binary files /dev/null and b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace15.png differ diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step9-2.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace16.png similarity index 100% rename from docs/installation-steps/img/google-cloud-marketplace/Step9-2.png rename to docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace16.png diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step9-3.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace17.png similarity index 100% rename from docs/installation-steps/img/google-cloud-marketplace/Step9-3.png rename to docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace17.png diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step9-4.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace18.png similarity index 100% rename from docs/installation-steps/img/google-cloud-marketplace/Step9-4.png rename to docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace18.png diff --git a/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace2.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace2.png new file mode 100644 index 000000000..a0341f4ee Binary files /dev/null and b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace2.png differ diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step3.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace3.png similarity index 100% rename from docs/installation-steps/img/google-cloud-marketplace/Step3.png rename to docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace3.png diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step4-1.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace4.png similarity index 100% rename from docs/installation-steps/img/google-cloud-marketplace/Step4-1.png rename to docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace4.png diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step4-2.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace5.png similarity index 100% rename from docs/installation-steps/img/google-cloud-marketplace/Step4-2.png rename to docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace5.png diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step5.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace6.png similarity index 100% rename from docs/installation-steps/img/google-cloud-marketplace/Step5.png rename to docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace6.png diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step6.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace7.png similarity index 100% rename from docs/installation-steps/img/google-cloud-marketplace/Step6.png rename to docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace7.png diff --git a/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace8.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace8.png new file mode 100644 index 000000000..2b61d390f Binary files /dev/null and b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace8.png differ diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step8-1.png b/docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace9.png similarity index 100% rename from docs/installation-steps/img/google-cloud-marketplace/Step8-1.png rename to docs/installation-steps/img/google-cloud-marketplace/GCPmarketplace9.png diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step2.png b/docs/installation-steps/img/google-cloud-marketplace/Step2.png deleted file mode 100644 index fe678b60e..000000000 Binary files a/docs/installation-steps/img/google-cloud-marketplace/Step2.png and /dev/null differ diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step7.png b/docs/installation-steps/img/google-cloud-marketplace/Step7.png deleted file mode 100644 index 9e0b3a37a..000000000 Binary files a/docs/installation-steps/img/google-cloud-marketplace/Step7.png and /dev/null differ diff --git a/docs/installation-steps/img/google-cloud-marketplace/Step9-1.png b/docs/installation-steps/img/google-cloud-marketplace/Step9-1.png deleted file mode 100644 index 1975486bb..000000000 Binary files a/docs/installation-steps/img/google-cloud-marketplace/Step9-1.png and /dev/null differ diff --git a/docs/installation-steps/img/google-cloud-marketplace/password1.png b/docs/installation-steps/img/google-cloud-marketplace/password1.png new file mode 100644 index 000000000..8546fdfc1 Binary files /dev/null and b/docs/installation-steps/img/google-cloud-marketplace/password1.png differ diff --git a/docs/installation-steps/img/google-cloud-marketplace/password2.png b/docs/installation-steps/img/google-cloud-marketplace/password2.png new file mode 100644 index 000000000..42129527d Binary files /dev/null and b/docs/installation-steps/img/google-cloud-marketplace/password2.png differ