diff --git a/_data/home-content.yml b/_data/home-content.yml index 06c2b4890..fce2a45e9 100644 --- a/_data/home-content.yml +++ b/_data/home-content.yml @@ -1,172 +1,3 @@ - - -- title: Getting started - icon: images/home-icons/started.svg - url: '' - links: - - title: Introduction to Codefresh - localurl: /docs/getting-started/intro-to-codefresh/ - - title: Codefresh for CI - localurl: /docs/getting-started/ci-codefresh/ - - title: Codefresh for CD - localurl: /docs/getting-started/cd-codefresh/ - - title: Codefresh for GitOps - localurl: /docs/getting-started/gitops-codefresh/ - - title: Concepts in Codefresh - localurl: /docs/getting-started/concepts/ - - -- title: Quick starts - icon: images/home-icons/started.svg - url: '' - links: - - title: Create Codefresh account - localurl: /docs/quick-start/create-codefresh-account/ - - title: CI pipeline quick start - localurl: /docs/quick-start/ci-quickstart/create-ci-pipeline/ - - title: Kubernetes deployment quick start - localurl: /docs/quick-start/ci-quickstart/deploy-to-kubernetes/ - - title: Helm quick start - localurl: /docs/quick-start/ci-quickstart/deploy-with-helm/ - -- title: Pipeline integrations - icon: images/home-icons/cloud-integrations.png - links: - - title: Hosted GitOps - localurl: /docs/integrations/codefresh-hosted-gitops/ - - title: Git Providers - localurl: /docs/integrations/git-providers/ - - title: Kubernetes - localurl: /docs/integrations/kubernetes/ - - title: Amazon Web Services - localurl: /docs/integrations/amazon-web-services/ - - title: Microsoft Azure - localurl: /docs/integrations/microsoft-azure/ - - title: Google Cloud - localurl: /docs/integrations/google-cloud/ - - title: Docker Registries - localurl: /docs/integrations/docker-registries/ - - title: Secret Storage - localurl: /docs/integrations/secret-storage/ - - title: Helm - localurl: /docs/integrations/helm/ - - title: Argo CD - localurl: /docs/integrations/argocd/ - - title: Datadog - localurl: /docs/integrations/datadog/ - - title: Jenkins integration/migration - localurl: /docs/integrations/jenkins-integration/ - - title: Codefresh API - localurl: /docs/integrations/codefresh-api/ - - - -- title: GitOps integrations - icon: images/home-icons/integrations.svg - url: '' - links: - - title: Image enrichment with GitOps integrations - localurl: /docs/gitops-integrations/image-enrichment-overview/ - - title: Codefresh Classic for GitOps - localurl: /docs/gitops-integrations/ci-integrations/codefresh-classic/ - - title: GitHub Actions for GitOps - localurl: /docs/gitops-integrations/ci-integrations/github-actions/ - - title: Jenkins for GitOps - localurl: /docs/gitops-integrations/ci-integrations/jenkins/ - - title: Jira for GitOps - localurl: /docs/gitops-integrations/issue-tracking/jira/ - - title: Amazon ECR for GitOps - localurl: /docs/gitops-integrations/container-registries/amazon-ecr/ - - title: Docker Hub Registry for GitOps - localurl: /docs/gitops-integrations/container-registries/dockerhub/ - - title: GitHub Container Registry for GitOps - localurl: /docs/gitops-integrations/container-registries/github-cr/ - - title: JFrog Artifactory for GitOps - localurl: /docs/gitops-integrations/container-registries/jfrog/ - - title: Quay Registry for GitOps - localurl: /docs/gitops-integrations/container-registries/quay/ - - - -- title: Getting started - icon: images/home-icons/started.svg - url: '' - links: - - title: Introduction to Codefresh - localurl: /docs/getting-started/intro-to-codefresh/ - - title: Codefresh for CI - localurl: /docs/getting-started/ci-codefresh/ - - title: Codefresh for CD - localurl: /docs/getting-started/cd-codefresh/ - - title: Codefresh for GitOps - localurl: /docs/getting-started/gitops-codefresh/ - - title: Concepts in Codefresh - localurl: /docs/getting-started/concepts/ - -- title: Dashboards & insights - icon: images/home-icons/guides.png - url: '' - links: - - title: Home dashboard - localurl: /docs/dashboards/home-dashboard/ - - title: DORA metrics - localurl: /docs/dashboards/dora-metrics/ - - -- title: Dashboards & insights - icon: images/home-icons/guides.png - url: '' - links: - - title: Home dashboard - localurl: /docs/dashboards/home-dashboard/ - - title: DORA metrics - localurl: /docs/dashboards/dora-metrics/ - - - -- title: CI/CD guides - icon: images/home-icons/guides.png - url: '' - links: - - title: Building your app - localurl: /docs/ci-cd-guides/packaging-compilation/ - - title: Building Docker images - localurl: /docs/ci-cd-guides/building-docker-images/ - - title: Accessing a Docker registry from Kubernetes cluster - localurl: /docs/ci-cd-guides/access-docker-registry-from-kubernetes/ - - title: Working with Docker registries - localurl: /docs/ci-cd-guides/working-with-docker-registries/ - - title: Adding config maps to namespaces - localurl: /docs/ci-cd-guides/add-config-maps-to-your-namespaces/ - - title: Pull Requests and branches - localurl: /docs/ci-cd-guides/pull-request-branches/ - - title: Pipelines for microservices - localurl: /docs/ci-cd-guides/microservices/ - - title: Deploying to predefined environments - localurl: /docs/ci-cd-guides/environment-deployments/ - - title: Previewing dynamic environments - localurl: /docs/ci-cd-guides/preview-environments/ - - title: Helm best practices - localurl: /docs/ci-cd-guides/helm-best-practices/ - - title: Templating for Kubernetes - localurl: /docs/ci-cd-guides/kubernetes-templating/ - - title: Progressive Delivery - localurl: /docs/ci-cd-guides/progressive-delivery/ - - - -- title: Example catalog - icon: images/home-icons/tutorial.svg - url: '' - links: - - title: CI examples - localurl: /docs/example-catalog/ci-examples - - title: CD examples - localurl: /docs/example-catalog/cd-examples - - title: GitOps examples - localurl: /docs/example-catalog/gitops-examples - - @@ -195,24 +26,24 @@ icon: images/home-icons/pipeline.svg url: '' links: - - title: Introduction to Pipelines - localurl: /docs/pipelines/introduction-to-codefresh-pipelines/ - - title: Creating Pipelines - localurl: /docs/pipelines/pipelines/ - - title: Pipeline triggers - localurl: /docs/pipelines/triggers/ - - title: Monitoring pipelines - localurl: /docs/pipelines/monitoring-pipelines/ - - title: Shared Configuration - localurl: /docs/pipelines/shared-configuration/ - - title: Using secrets - localurl: /docs/pipelines/secrets-store/ - - title: Pipeline caching - localurl: /docs/pipelines/pipeline-caching/ - - title: Running pipelines locally - localurl: /docs/pipelines/running-pipelines-locally/ - - title: Debugging pipelines - localurl: /docs/pipelines/debugging-pipelines/ + - title: Introduction to Pipelines + localurl: /docs/pipelines/introduction-to-codefresh-pipelines/ + - title: Creating Pipelines + localurl: /docs/pipelines/pipelines/ + - title: Pipeline triggers + localurl: /docs/pipelines/triggers/ + - title: Monitoring pipelines + localurl: /docs/pipelines/monitoring-pipelines/ + - title: Shared Configuration + localurl: /docs/pipelines/shared-configuration/ + - title: Using secrets + localurl: /docs/pipelines/secrets-store/ + - title: Pipeline caching + localurl: /docs/pipelines/pipeline-caching/ + - title: Running pipelines locally + localurl: /docs/pipelines/running-pipelines-locally/ + - title: Debugging pipelines + localurl: /docs/pipelines/debugging-pipelines/ - title: Workflows @@ -224,16 +55,21 @@ - title: Nested workflows localurl: /docs/workflows/nested-workflows/ - title: Configure artifact repository - localurl: /docs/pipelines/configure-artifact-repository/ localurl: /docs/workflows/configure-artifact-repository/ - title: Selectors for concurrency synchronization - localurl: /docs/pipelines/concurrency-limit/ localurl: /docs/workflows/concurrency-limit/ - title: Sharing file systems - localurl: /docs/pipelines/sharing-file-system/ localurl: /docs/workflows/sharing-file-system/ + + +- title: Clients + icon: images/home-icons/client.svg + url: '' + links: + - title: Codefresh CLI + localurl: /docs/clients/csdp-cli/ - title: Installation @@ -242,11 +78,11 @@ links: - title: Installation environments localurl: /docs/installation/installation-options/ - - title: Codefresh Runner installation + - title: Codefresh Runner CI/CD installation localurl: /docs/installation/codefresh-runner/ - - title: On-Premises installation + - title: On-Premises CI/CD installation localurl: /docs/installation/codefresh-on-prem/ - - title: On-Premises upgrade + - title: On-Premises CI/CD upgrade localurl: /docs/installation/codefresh-on-prem-upgrade/ - title: Hosted GitOps Runtime installation localurl: /docs/installation/hosted-runtime/ @@ -264,24 +100,24 @@ icon: images/home-icons/administration.svg url: '' links: - - title: Create a Codefresh account - localurl: /docs/administration/account-user-management/create-codefresh-account/ - - title: Adding users and teams - localurl: /docs/administration/account-user-management/add-users/ - - title: Single Sign-On - localurl: /docs/single-sign-on/ - - title: Set up OAuth2 authentication for Git providers - localurl: /docs/administration/account-user-management/oauth-setup/ - - title: Access control - localurl: /docs/administration/account-user-management/access-control/ - - title: Audit - localurl: /docs/administration/account-user-management/audit/ - - title: Codefresh IP addresses - localurl: /docs/administration/account-user-management/platform-ip-addresses/ - - title: User settings - localurl: /docs/administration/user-self-management/user-settings/ - - title: Manage Git PATs - localurl: /docs/administration/user-self-management/manage-pats/ + - title: Create a Codefresh account + localurl: /docs/administration/account-user-management/create-codefresh-account/ + - title: Adding users and teams + localurl: /docs/administration/account-user-management/add-users/ + - title: Single Sign-On + localurl: /docs/single-sign-on/ + - title: Set up OAuth2 authentication for Git providers + localurl: /docs/administration/account-user-management/oauth-setup/ + - title: Access control + localurl: /docs/administration/account-user-management/access-control/ + - title: Audit + localurl: /docs/administration/account-user-management/audit/ + - title: Codefresh IP addresses + localurl: /docs/administration/account-user-management/platform-ip-addresses/ + - title: User settings + localurl: /docs/administration/user-self-management/user-settings/ + - title: Manage Git PATs + localurl: /docs/administration/user-self-management/manage-pats/ - title: Reference diff --git a/_data/nav.yml b/_data/nav.yml index a3b881548..eeb18f1cd 100644 --- a/_data/nav.yml +++ b/_data/nav.yml @@ -1,191 +1,3 @@ -- title: Getting started - url: "/getting-started" - pages: - - title: Introduction to Codefresh - url: "/intro-to-codefresh" - - title: Codefresh for CI - url: "/ci-codefresh" - - title: Codefresh for CD - url: "/cd-codefresh" - - title: Codefresh for GitOps - url: "/gitops-codefresh" - - title: Concepts in Codefresh - url: "/concepts" - -- title: Quick starts - url: "/quick-start" - pages: - - title: Create Codefresh account - url: "/create-codefresh-account" - - title: CI/CD quick starts - url: "/ci-quickstart" - sub-pages: - - title: CI pipeline quick start - url: "/create-ci-pipeline" - - title: Kubernetes deployment quick start - url: "/deploy-to-kubernetes" - - title: Helm quick start - url: "/deploy-with-helm" - - - - -- title: Dashboards & Insights - url: "/dashboards" - pages: - - title: Home dashboard - url: "/home-dashboard" - - title: DORA metrics - url: "/dora-metrics" - - - -- title: CI/CD Guides - url: "/ci-cd-guides" - pages: - - title: Building your app - url: "/packaging-compilation" - - title: Building Docker images - url: "/building-docker-images" - - title: Accessing Docker registries from Kubernetes cluster - url: "/access-docker-registry-from-kubernetes" - - title: Working with Docker registries - url: "/working-with-docker-registries" - - title: Adding config maps to namespaces - url: "/add-config-maps-to-your-namespaces" - - title: Pull Requests and branches - url: "/pull-request-branches" - - title: Building microservices - url: "/microservices" - - title: Deploying to predefined environments - url: "/environment-deployments" - - title: Previewing dynamic environments - url: "/preview-environments" - - title: Progressive delivery - url: "/progressive-delivery" - - title: GitOps deployments - url: "/gitops-deployments" - - title: Helm best practices - url: "/helm-best-practices" - - title: Kubernetes templating - url: "/kubernetes-templating" - - - - -- title: Example catalog - url: "/example-catalog" - pages: - - title: CI examples - url: "/ci-examples" - sub-pages: - - title: Check out Git repositories - url: "/git-checkout" - - title: Custom Git commmands - url: "/git-checkout-custom" - - title: Non-Git checkouts - url: "/non-git-checkout" - - title: Use Git Hash in CI - url: "/get-short-sha-id-and-use-it-in-a-ci-process" - - title: Build an Image with the Dockerfile in root directory - url: "/build-an-image-with-the-dockerfile-in-root-directory" - - title: Build an Images specifying Dockerfile Location - url: "/build-an-image-specify-dockerfile-location" - - title: Build an Image from a different Git repository - url: "/build-an-image-from-a-different-git-repository" - - title: Build and push an Image - url: "/build-and-push-an-image" - - title: Build an Image with build arguments - url: "/build-an-image-with-build-arguments" - - title: Share data between steps - url: "/shared-volumes-between-builds" - - title: Upload/download from Google Storage buckets - url: "/uploading-or-downloading-from-gs" - - title: Call other pipelines - url: "/call-child-pipelines" - - title: Run unit tests - url: "/run-unit-tests" - - title: Run integration tests - url: "/run-integration-tests" - - title: Fan-in/fan-out with unit tests - url: "/fan-in-fan-out" - - title: Codecov coverage reports - url: "/codecov-testing" - - title: Coveralls coverage reports - url: "/coveralls-testing" - - title: Codacy coverage reports - url: "/codacy-testing" - - title: Run integration tests with Mongo - url: "/integration-tests-with-mongo" - - title: Run integration tests with MySQL - url: "/integration-tests-with-mysql" - - title: Run integration tests with PostgreSQL - url: "/integration-tests-with-postgres" - - title: Run integration tests with Redis - url: "/integration-tests-with-redis" - - title: Populate a database with existing data - url: "/populate-a-database-with-existing-data" - - title: Share volumes in composition steps - url: "/shared-volumes-of-service-from-composition-step-for-other-yml-steps" - - title: Import data to MongoDB - url: "/import-data-to-mongodb" - - title: Vault Secrets in the Pipeline - url: "/vault-secrets-in-the-pipeline" - - title: Decrypt with Mozilla SOPS - url: "/decryption-with-mozilla-sops" - - title: GitOps secrets - url: "/gitops-secrets" - - title: Launch Composition - url: "/launch-composition" - - title: Use Docker compose - url: "/launching-a-composition-and-defining-a-service-environment-variables-using-a-file" - - title: Send notification to Slack - url: "/sending-the-notification-to-slack" - - title: Send notification to Jira - url: "/sending-the-notification-to-jira" - - title: CD examples - url: "/cd-examples" - sub-pages: - - title: Import data to MongoDB - url: "/import-data-to-mongodb" - - title: NodeJS + Angular2 + MongoDB - url: "/nodejs-angular2-mongodb" - - title: Secure a Docker Container Using HTTP Basic Auth - url: "/secure-a-docker-container-using-http-basic-auth" - - title: Spring Boot + Kafka + Zookeeper - url: "/spring-boot-kafka-zookeeper" - - title: Web terminal - url: "/web-terminal" - - title: Trigger a K8s Deployment from a DockerHub Push Event - url: "/trigger-a-k8s-deployment-from-docker-registry" - - title: Deploy to VM - url: "/packer-gcloud" - - title: Deploy to a VM via FTP - url: "/transferring-php-ftp" - - title: Deploy to Tomcat using SCP - url: "/deploy-to-tomcat-via-scp" - - title: Deploy with Helm - url: "/helm" - - title: Deploy with Terraform - url: "/terraform" - - title: Deploy with Pulumi - url: "/pulumi" - - title: Deploy to Nomad - url: "/nomad" - - title: Deploy to Heroku - url: "/deploy-to-heroku" - - title: Use kubectl as part of Freestyle step - url: "/use-kubectl-as-part-of-freestyle-step" - - title: Deploy with Kustomize - url: "/deploy-with-kustomize" - - title: Deploy to Docker Swarm - url: "/docker-swarm" - - title: Amazon ECS/Fargate - url: "/amazon-ecs" - - title: Elastic Beanstalk - url: "/elastic-beanstalk" - - title: GitOps examples - url: "/cd-examples" - title: Deployments url: "/deployments" @@ -315,112 +127,6 @@ url: "/what-is-the-codefresh-yaml" -- title: Pipeline integrations - url: "/integrations" - pages: - - title: Codefresh Hosted GitOps - url: "/codefresh-hosted-gitops" - - title: Git Providers - url: "/git-providers" - - title: Kubernetes - url: "/kubernetes" - - title: Amazon Services - url: "/amazon-web-services" - - title: Microsoft Azure - url: "/microsoft-azure" - - title: Google Cloud - url: "/google-cloud" - - title: Docker registries - url: "/docker-registries" - sub-pages: - - title: Docker Hub - url: "/docker-hub" - - title: Azure Docker Registry - url: "/azure-docker-registry" - - title: Amazon EC2 Container Registry - url: "/amazon-ec2-container-registry" - - title: Google Container Registry - url: "/google-container-registry" - - title: Google Artifact Registry - url: "/google-artifact-registry" - - title: JFrog Bintray.io/Artifactory - url: "/bintray-io" - - title: Quay.io - url: "/quay-io" - - title: GitHub Container Registry - url: "/github-container-registry" - - title: DigitalOcean Container Registry - url: "/digital-ocean-container-registry" - - title: Other Registries - url: "/other-registries" - - title: Secret Storage - url: "/secret-storage" - - title: Hashicorp Vault - url: "/hashicorp-vault" - - title: Helm Integration - url: "/helm" - - title: ArgoCD Integration - url: "/argocd" - - title: Datadog Integration - url: "/datadog" - - title: Jira Integration - url: "/jira" - - title: Jenkins Integration - url: "/jenkins-integration" - - title: Codecov Integration - url: "/codecov-integration" - - title: Google Cloud builder - url: "/gcloud-builder" - - title: Google Marketplace Installation - url: "/google-marketplace" - - title: GitHub Actions - url: "/github-actions" - - title: Notifications - url: "/notifications" - sub-pages: - - title: Slack - url: "/slack-integration" - - title: Jira - url: "/jira-integration" - - title: Codefresh API - url: "/codefresh-api" - - -- title: GitOps integrations - url: "/gitops-integrations" - pages: - - title: Image enrichment with GitOps integrations - url: "/image-enrichment-overview" - - title: GitOps CI integrations - url: "/ci-integrations" - sub-pages: - - title: Codefresh Classic - url: "/codefresh-classic" - - title: GitHub Actions - url: "/github-actions" - - title: Jenkins - url: "/jenkins" - - title: GitOps issue tracking integrations - url: "/issue-tracking" - sub-pages: - - title: Jira - url: "/jira" - - title: GitOps container registry integrations - url: "/container-registries" - sub-pages: - - title: Amazon ECR - url: "/amazon-ecr" - - title: Docker Hub Registry - url: "/dockerhub" - - title: GitHub Container Registry - url: "/github-cr" - - title: JFrog Artifactory - url: "/jfrog" - - title: Quay Registry - url: "/quay" - - - - title: Workflows url: "/workflows" pages: @@ -444,7 +150,6 @@ url: "/csdp-cli" - - title: Installation url: "/installation" pages: @@ -469,11 +174,11 @@ - title: Add Git Sources to to GitOps Runtimes url: "/git-sources" + - title: Administration url: "/administration" pages: - title: Account & user management - url: /account-user-management sub-pages: - title: Create a Codefresh account url: "/create-codefresh-account" @@ -499,10 +204,6 @@ - title: Single Sign-On url: /single-sign-on pages: - - title: SSO Overview - url: /sso-overview - - title: Common configuration - url: /team-sync - title: OpenID Connect url: /oidc sub-pages: @@ -529,7 +230,8 @@ url: /saml-pingid - title: LDAP url: /ldap - + - title: Common configuration + url: /team-sync - title: Reference @@ -543,59 +245,7 @@ url: "/shared-configuration" -- title: Troubleshooting - url: "/troubleshooting" - pages: - - title: Common Issues - url: "/common-issues" - sub-pages: - - title: Can't find your organization repositories - url: "/cant-find-your-organization-repositories" - - title: Can’t find your private repositories - url: "/cant-find-your-private-repositories" - - title: 'Clone step failed: Command [git checkout $REVISION] exited with code [1]' - url: "/git-clone-step-issue" - - title: Handling commit messages with a quote character - url: "/handling-commit-messages-with-quotes" - - title: Docker image does not exist or no pull access - url: "/the-docker-image-does-not-exist-or-no-pull-access" - - title: 'Build step: No such file or directory' - url: "/build-step-no-such-file-or-directory" - - title: No Dockerfile found - url: "/no-dockerfile-found" - - title: Failed to tag image - url: "/could-not-tag-image" - - title: Error Code 137 - url: "/error-code-137" - - title: Too many requests - url: "/dockerhub-rate-limit" - - title: Restoring data from pre-existing image hangs on - url: "/restoring-data-from-pre-existing-image-hangs-on" - - title: Disabling codefresh caching mechanisms - url: "/disabling-codefresh-caching-mechanisms" - - title: Pinning codefresh.yml for multi-git triggers - url: "/multi-git-triggers" - - title: Workflow terminated by the system - url: "/workflow-terminated-by-system" - - title: cf_export limitations - url: "/cf-export-limitations" - - title: Validation port warnings - url: "/validation-port-warnings" - - title: Forbidden Kubernetes resources - url: "/forbidden-cluster-resources" - - title: How to use SSH keys in freestyle steps - url: "using-ssh-keys" - - title: Failed to get accounts clusters during workflow - url: "/failed-to-get-accounts-clusters-during-workflow" - - title: Paging issues for builds and images - url: "/paging-issues-builds-images" - - title: Git step migration - url: "/git-step-migration" - - title: Personal Git Deprecation - url: "/personal-git-deprecation" - - title: GitOPs runtimes - url: "/runtime-issues" - + - title: Terms and Privacy Policy url: "/terms-and-privacy-policy" @@ -608,4 +258,3 @@ url: "/sla" - diff --git a/_docs/administration/account-user-management/create-codefresh-account.md b/_docs/administration/account-user-management/create-codefresh-account.md index 9de8d7e32..158246684 100644 --- a/_docs/administration/account-user-management/create-codefresh-account.md +++ b/_docs/administration/account-user-management/create-codefresh-account.md @@ -3,7 +3,11 @@ title: "Create a Codefresh account" description: "Welcome to Codefresh!" group: administration sub_group: account-user-management -toc: true +redirect_from: + - /docs/ + - /docs/create-an-account/ + - /docs/getting-started/ + - /docs/getting-started/introduction/ --- Before you can do anything in Codefresh such as building and deploying your applications, you need to create a Codefresh account. @@ -19,7 +23,7 @@ max-width="90%" %} ## Step 1: Select your Identity Provider -As the first step in setting up your account in Codefresh, select the identity provider (IdP) to use. +As the first step in setting up ypur account in Codefresh, select the identity provider (IdP) to use. Codefresh currently supports the following IdPs: * GitHub * Bitbucket @@ -33,7 +37,7 @@ If you need an IdP that is not in the list, please [contact us](https://codefres >NOTES: For Git repositories, the login method is less important, as you can Git repositories through [Git integrations]({{site.baseurl}}/docs/integrations/git-providers/), regardless of your sign-up process. - If you have multiple sign-up methods, as long as you use the same email address in all the sign-ups, Codefresh automatically redirects you to the account dashboard. + If you multiple sign-up methods, as long as you use the same email address in all the sign-ups, Codefresh automatically redirects you to the account dashboard. 1. Go to the [Codefresh Sign Up page](https://g.codefresh.io/signup). diff --git a/_docs/administration/user-self-management/user-settings.md b/_docs/administration/user-self-management/user-settings.md index d3a9a2089..ad969ff3b 100644 --- a/_docs/administration/user-self-management/user-settings.md +++ b/_docs/administration/user-self-management/user-settings.md @@ -99,7 +99,6 @@ caption="Generating a key for the API" max-width="80%" %} -> The UI shows the first few characters in the second part of the key, after the `.`, and not the characters at the beginning of the key. ## Related articles diff --git a/_docs/dashboards/dora-metrics.md b/_docs/dashboards/dora-metrics.md deleted file mode 100644 index 6230c340d..000000000 --- a/_docs/dashboards/dora-metrics.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "DORA metrics" -description: "Get insights into your deployments" -group: dashboards -toc: true ---- - -DevOps is a collaboration paradigm that is sometimes mistaken for being too abstract or too generic. In an effort to quantify the benefits of adopting DevOps, [Dora Research](https://www.devops-research.com/research.html#capabilities){:target="\_blank"} (acquired by Google in 2018), has introduced four key metrics that define specific goals for improving the software lifecycle in companies interested in adopting DevOps. - -DORA measures these metrics: - -* Deployment Frequency: How often an organization successfully releases to production -* Lead Time for Changes: The length of time for a commit to be deployed into production -* Change Failure Rate: The percentage of deployments causing a failure in production -* Time to Restore Service: The length of time for an organization to recover from a failure in production - -[Read more on DORA](https://cloud.google.com/blog/products/devops-sre/using-the-four-keys-to-measure-your-devops-performance){:target="\_blank"}. - -## DORA metrics in Codefresh - -Monitoring DORA metrics can help identify delivery issues in your organization by detecting bottlenecks among teams and optimize your workflows at technical or organizational levels. -Codefresh offers support for DORA metrics out of the box. - -* In the Codefresh UI, go to [DORA metrics](https://g.codefresh.io/2.0/dora-dashboard/dora){:target="\_blank"}. - -{% include -image.html -lightbox="true" -file="/images/reporting/dora-metrics.png" -url="/images/reporting/dora-metrics.png" -alt="DORA metrics report" -caption="DORA metrics report" -max-width="100%" -%} - -## Filters - -Use filters to define the exact subset of applications you are interested in. All filters support auto-complete and multiselect. -More than one option within the same filter type has an OR relationship. Multiple filter types when defined share an AND relationship. - -* Runtimes: Show metrics for applications from selected runtimes -* Clusters: Show metrics for applications deployed to selected clusters -* Applications: Show metrics for selected applications. -* Time: Show metrics from application for a specific time period - -> When no filters are defined, all metrics are shown for the last 90 days. - -## Metrics for favorite applications -If you have [starred applications as favorites]({{site.baseurl}}/docs/deployment/applications-dashboard/#applications-dashboard-information) in the Applications dashboard, clicking {::nomarkdown}{:/} in DORA metrics, displays DORA metrics only for those applications. - - -## Metric totals -As the title indicates, the Totals bar shows the total numbers, based on the filters defined, or for the last 90 days, if there are no filters: - -* Deployments -* Rollbacks -* Commits/Pull Requests -* Failure Rate: The number of failed deployments divided by the total number of deployments - -## Metric graphs -The metric graphs are key to performance insights with DORA metrics. The metrics are again based on the filters defined, or for the last 90 days if there are no filters. - -In addition, you can select the granularity for each graph: - -* Daily -* Weekly -* Monthly - ->Tip: - Remember that the graphs for the DORA metrics reflect metrics of application deployments, not workflows. - -**Deployment Frequency** - The frequency at which applications are deployed to production, including both successful (Healthy) and failed (Degraded), deployments. A deployment is considered an Argo CD sync where there was a change in the application source code that resulted in a new deployment of the application to production. - The X-axis charts the time based on the granularity selected, and the Y-axis charts the number of deployments. The number shown on the top right is the average deployment frequency based on granularity. - -**Lead Time for Changes** - The average number of days from the first commit for a PR (pull request) until the deployment date for the same PR. The key term here is _deployment_. Lead Time for Changes considers only those changes to workflows that result in a deployment. Making a change to a repo that does not result in a deployment is not included when calculating Lead Time for Changes. - The X-axis charts the time based on the granularity selected, and the Y-axis charts the time in minutes until the deployment. The number shown on the top right is the average number of days for a commit to reach production. - -**Change Failure Rate** - The failure or rollback rate in percentage for applications whose health status changed to Degraded on deployment. The key term here is _on deployment_. For example, bumping an image tag with one that does not exist, results in the application being Degraded on deployment, and designated as failed. - The Change Failure Rate is derived by dividing the number of Degraded (failed/rollback) deployments with the total number of deployments. - The X-axis charts the time based on the granularity selected, and the Y-axis charts the failure rate. The number shown on the top right is the average failure rate based on granularity, and therefore may not be equal to the Total Failure Rate. - -**Time to Restore Service** - The average number of hours taken for the status of Degraded deployments to return to Healthy. Again, similar to the Change Failure Rate, Time to Restore Service includes only deployments that became Degraded. It is derived by dividing the total number of hours for all Degraded deployments to return to Healthy by the total number of Degraded deployments. - The X-axis charts the time based on the granularity, and the Y-axis charts the time in hours. The number shown on the top right is the average number of hours between the previous deployment and rollback for the same application. - -## Related articles -[Global analytics dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard) -[Monitoring applications]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/) - diff --git a/_docs/dashboards/home-dashboard.md b/_docs/dashboards/home-dashboard.md deleted file mode 100644 index be0e4e505..000000000 --- a/_docs/dashboards/home-dashboard.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: "Global analytics dashboard" -description: "" -group: dashboards -toc: true ---- - -Get a global picture of runtimes, managed clusters, deployments, and pipelines in the Home dashboard. The Home dashboard is displayed when you log in to Codefresh, providing system-wide visualization in real-time. - -Global filters allow you to narrow the scope of the data, and drill down into specific entities for more details. - - {% include - image.html - lightbox="true" - file="/images/reporting/home-dashboard.png" - url="/images/reporting/home-dashboard.png" - alt="Home dashboard: Global enterprise analytics" - caption="Home dashboard: Global enterprise analytics" - max-width="70%" - %} - -### Global filters -Filter the view in the Home dashboard by runtimes and date range. - -{% include - image.html - lightbox="true" - file="/images/reporting/global-filters.png" - url="/images/reporting/global-filters.png" - alt="Home dashboard: Global filters" - caption="Home dashboard: Global filters" - max-width="60%" - %} - -### Runtimes and Managed Clusters - -Identify the health of the runtimes and managed clusters in your enterprise. -Health status is displayed for both hosted (if you have Hosted GitOps), and hybrid runtimes. - -Managed clusters are external clusters registered to runtimes to which you deploy applications and GitOps-managed resources. - - {% include - image.html - lightbox="true" - file="/images/reporting/runtimes-clusters-widgets.png" - url="/images/reporting/runtimes-clusters-widgets.png" - alt="Runtimes and Managed Clusters in the Home dashboard" - caption="Runtimes and Managed Clusters in the Home dashboard" - max-width="80%" - %} - -{: .table .table-bordered .table-hover} -| Item | Description | -| ------------------------| ---------------- | -|**Runtimes** | Identify failed runtimes.| -|**Managed Clusters** |{::nomarkdown} {:/}| - - -### Deployments - -Identify trends for deployments. - - {% include - image.html - lightbox="true" - file="/images/reporting/deployments-widget.png" - url="/images/reporting/deployments-widget.png" - alt="Deployments in the Home dashboard" - caption="Deployments in the Home dashboard" - max-width="70%" - %} - -{: .table .table-bordered .table-hover} -| Item | Description | -| ------------------------| ---------------- | -|**Daily/Weekly/Monthly** | Granularity for deployment views that affects the average number of deployments and the comparison to the reference period.| -|**Number and Comparison Average** | The number on the top right is the number of successful/failed/rollback deployments for the selected granularity. The percentage is the comparison to the reference period, also for the selected granularity. | -|**Successful** | The number of successful deployments per day, week, or month according to the selected granularity. | -|**Failed Deployments** | The number of successful deployments per day, week, or month according to the selected granularity. | -|**Rollbacks** | The number of successful deployments per day, week, or month according to the selected granularity. | - - - -### Applications - -Displays up to five of the most active applications and their current deployment status. - -{% include - image.html - lightbox="true" - file="/images/reporting/applications-widget.png" - url="/images/reporting/applications-widget.png" - alt="Applications in the Home dashboard" - caption="Applications in the Home dashboard" - max-width="70%" - %} - -{: .table .table-bordered .table-hover} - -| Item | Description | -| ------------------------| ---------------- | -|**Filter** | Filter applications by the cluster on which they are deployed. | -|**View** | Click to go to the Applications dashboard. See | -|**Application Name** | The name of the application, and the names of the runtime and cluster on which it is deployed. Click the name to drill down into the application in the Applications dashboard. | -|**Health status** | The health status of the application, and can be either:{::nomarkdown} To see the breakdown by health status, mouse over the chart.
The number at the end of the bar is the total number of deployments for the application, with the overall decrease or increase compared to the reference period. {:/} | - - - -### Delivery Pipelines - -> Delivery Pipline data is shown for hybrid enviroments. - -Displays all active pipelines for the selected date range, providing insights into trends for pipelines. Active pipelines are those with at least one active or completed workflow. -Analytics are derived by comparing the selected date range to the corresponding reference period. If your date range is the last seven days, the reference period is the seven days that precede the date range. - -{% include - image.html - lightbox="true" - file="/images/reporting/delivery-pipeline-widget.png" - url="/images/reporting/delivery-pipeline-widget.png" - alt="Delivery Pipelines in the Home dashboard" - caption="Delivery Pipelines in the Home dashboard" - max-width="80%" - %} - -{: .table .table-bordered .table-hover} - -| Item | Description | -| ------------------------| ---------------- | -|**Pipelines** | The number prefixed to the pipeline name indicates the change in position of the pipeline compared to the reference period. To drill down into a specific pipeline, click the pipeline.| -|**Filter** | The filters available to focus on the pipelines of interest:{::nomarkdown}{:/} | -|**View** | Click to go to the Delivery Pipelines dashboard. | -|**KPI Averages** | KPI averages for: {::nomarkdown} To see detailed day-to-day values, select a line chart.{:/}| -|**Most Active Delivery Pipelines** | Up to ten pipelines with the highest number of executions. The same KPIs are displayed, and compared to those in the reference period. | -|**Longest Delivery Pipelines** | Up to ten pipelines with the longest duration. The same KPIs are displayed, and compared to those in the reference period. | - -### Related articles -[DORA metrics]({{site.baseurl}}/docs/dashboards/dora-metrics/) -[Monitoring applications]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/) -[Images in Codefresh]({{site.baseurl}}/docs/deployments/gitops/images/) - - diff --git a/_docs/deployments/gitops/applications-dashboard.md b/_docs/deployments/gitops/applications-dashboard.md new file mode 100644 index 000000000..51907f811 --- /dev/null +++ b/_docs/deployments/gitops/applications-dashboard.md @@ -0,0 +1,788 @@ +--- +title: "Monitoring GitOps applications" +description: "" +group: deployments +sub_group: gitops +toc: true +--- + +Monitor applications across clusters, and the deployments, resources, and services for an application in the Applications dashboard. As a one-stop shop for Argo Rollouts and Argo CD, the Applications dashboard in Codefresh delivers on the challenge of keeping track of your applications and their deployments, whatever the frequency and scale, across all clusters in your enterprise. A wide range of filters, progressive delivery views, and enriched CI and CD information, provide full traceability and visibility to your deployments. + +Select the view format for the Applications Dashboard, as either [List or Card views](#select-view-mode-for-the-applications-dashboard). The default view displays all applications deployed within the last 30 days. Customize the scope through filters to display the [information](#applications-dashboard-information) you need. + +{% include +image.html +lightbox="true" +file="/images/applications/app-dashboard-main-view.png" +url="/images/applications/app-dashboard-main-view.png" +alt="Applications Dashboard: List view" +caption="Applications Dashboard: List view" +max-width="60%" +%} + + +Monitor the current [health and sync status of applications](#identify-applications-with-warningserrors), and then select an application to drill down into its resources, deployments, and services: +* [View deployment and configuration info for selected application](#view-deployment-and-configuration-info-for-selected-application) +* [Monitor health and sync statuses for selected application](#monitor-health-and-sync-statuses-for-selected-application) +* [Monitor resources for selected application](#monitor-resources-for-selected-application) +* [Monitor deployments for selected application](#monitor-deployments-for-selected-application) +* [Monitor services for selected application](#monitor-services-for-selected-application) + +>For information on creating and managing applications and application resources, see [Creating applications]({{site.baseurl}}/docs/deployments/gitops/create-application/) and [Managing applications]({{site.baseurl}}/docs/deployments/gitops/manage-application/). + +## Select view mode for the Applications dashboard +View deployed applications in either List (the default) or Card views. Both views are sorted by the most recent deployments. + +1. In the Codefresh UI, go to the [Applications dashboard](https://g.codefresh.io/2.0/applications-dashboard/list){:target="\_blank"}. +1. Select **List** or **Cards**. + +### Applications List view + +Here is an example of the Applications dashboard in List view mode. + +{% include +image.html +lightbox="true" +file="/images/applications/app-dashboard-main-view.png" +url="/images/applications/app-dashboard-main-view.png" +alt="Applications Dashboard: List view" +caption="Applications Dashboard: List view" +max-width="60%" +%} + +### Applications Card view +Here is an example of the Applications dashboard in Card view mode. The Card view provides a scannable view of application data and the actions to manage applications. + + {% include +image.html +lightbox="true" +file="/images/applications/app-dashboard-card-view.png" +url="/images/applications/app-dashboard-card-view.png" +alt="Applications Dashboard: Card view" +caption="Applications Dashboard: Card view" +max-width="60%" +%} + +## Applications dashboard information +Here's a description of the information and actions in the Applications dashboard. + +{: .table .table-bordered .table-hover} +| Item | Description | +| -------------- | -------------- | +|Application filters | Filter by a range of attributes to customize the information in the dashboard to bring you what you need. {::nomarkdown} {:/}| +|{::nomarkdown}{:/}| Star applications as favorites and view only the starred applications.{::nomarkdown}
Select the to star the application as a favorite.

To filter by favorite applications, on the filters bar, select .
{:/} TIP: If you star applications as favorites in the Applications dashboard, you can filter by the same applications in the [DORA metrics dashboard]({{site.baseurl}}/docs/reporting/dora-metrics/#metrics-for-favorite-applications). | +|Application actions| Options to monitor/manage applications through the application's context menu. {::nomarkdown}