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

Gitops revamp quick starts #1116

Merged
merged 48 commits into from
Dec 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
834cfb6
Update quick starts
NimRegev Dec 3, 2024
7a8cf91
Update screenshots
NimRegev Dec 3, 2024
a7d1376
Updated screenshots
NimRegev Dec 3, 2024
fb8049d
Update screenshots
NimRegev Dec 3, 2024
589c0c3
Updated screenshots
NimRegev Dec 3, 2024
31ecbfc
Update promotion quick starts
NimRegev Dec 4, 2024
e61d778
Update promotion quick starts
NimRegev Dec 4, 2024
075119f
Update promotion quick starts
NimRegev Dec 4, 2024
d3f323c
Update parallel flow
NimRegev Dec 4, 2024
4aaef58
Update gitops quick start
NimRegev Dec 5, 2024
bdd82cb
Update product quick starts
NimRegev Dec 5, 2024
1b612e1
Update promotion quick starts
NimRegev Dec 8, 2024
b76baba
Update promotion quick starts
NimRegev Dec 8, 2024
080087f
Update promotion quick starts
NimRegev Dec 8, 2024
593aabe
Update nav.yml
NimRegev Dec 8, 2024
a332100
Update gitops-products.md
NimRegev Dec 8, 2024
a05de5b
Move CI quick starts
NimRegev Dec 8, 2024
6ae2170
Merge branch 'master' into gitops-revamp-quick-starts
NimRegev Dec 8, 2024
74cc32f
Update home-content.yml
NimRegev Dec 8, 2024
7d80fe5
Update nav.yml
NimRegev Dec 8, 2024
875c76f
Update nav.yml
NimRegev Dec 8, 2024
1fbbf06
Update drag-and-drop.md
NimRegev Dec 8, 2024
f11e8f9
Rename overview files
NimRegev Dec 8, 2024
2b063c2
Update applications.md
NimRegev Dec 8, 2024
ba05c61
Update quick starts
NimRegev Dec 19, 2024
332eaab
Update screenshots for quick starts
NimRegev Dec 19, 2024
9f85a5d
Update screenshots for quick starts
NimRegev Dec 19, 2024
0711015
Update runtime quick starts
NimRegev Dec 19, 2024
ef268b3
Update front matter and overviews
NimRegev Dec 19, 2024
e8c5b6e
added redirect for quickstart based on home-content.yaml
lukasmagik Dec 20, 2024
84f4cbf
Remove duplicate set of promotion tutorials
NimRegev Dec 22, 2024
84e2af6
Add redirects to promotion quick starts
NimRegev Dec 23, 2024
6206376
Add more redirects
NimRegev Dec 23, 2024
dee99b7
Resolve conflicts
NimRegev Dec 23, 2024
7cc9e82
Merge commit '73f1b24d7bf765d4df2bbf4d64cefbf9335d522e' into HEAD
ATGardner Dec 23, 2024
fec45ee
Update gitops-quick-start.md
NimRegev Dec 23, 2024
21248f4
Update links to quick starts
NimRegev Dec 23, 2024
82e117e
Merge branch 'master' into gitops-revamp-quick-starts
NimRegev Dec 24, 2024
8854fae
Update quick starts
NimRegev Dec 24, 2024
81e06f1
Merge branch 'gitops-revamp-quick-starts' of https://github.com/codef…
NimRegev Dec 24, 2024
623992e
Update quick starts
NimRegev Dec 24, 2024
2930656
Update gitops quick starts for promotions
NimRegev Dec 24, 2024
ff061b5
Update promotion quick starts
NimRegev Dec 25, 2024
302be2d
Add release task to dependencies
NimRegev Dec 29, 2024
e9bc58c
fix syntax error
NimRegev Dec 29, 2024
5674ac4
Update content for gitops quick starts
NimRegev Dec 29, 2024
9f038c3
Update promotion-scenarios.md
NimRegev Dec 29, 2024
be25ad9
Update promotion-scenarios.md
NimRegev Dec 29, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions _data/home-content.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,10 @@
icon: images/home-icons/tutorial.svg
url: ""
links:
- title: Create Codefresh account
localurl: /docs/quick-start/create-codefresh-account/
- title: CI/CD quick starts
localurl: /docs/quick-start/ci-quick-start/
localurl: /docs/ci-quick-start/ci-quick-start/
- title: GitOps quick starts
localurl: /docs/quick-start/gitops-quick-start/
- title: Promotions
localurl: /docs/promotions/promotion-scenarios/
localurl: /docs/gitops-quick-start/gitops-quick-start/

- title: Products
icon: images/home-icons/product.svg
Expand Down Expand Up @@ -143,8 +139,6 @@
- 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: OpenID Connect
Expand Down
94 changes: 52 additions & 42 deletions _data/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,39 +14,60 @@
- title: Global Search & Navigation
url: "/command-bar"

- title: Quick starts
url: "/quick-start"
- title: CI/CD quick starts
url: "/ci-quick-start"
pages:
- title: Create Codefresh account
url: "/create-codefresh-account"
- title: CI/CD quick starts
url: "/ci-quick-start"
sub-pages:
- title: 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: On-demand environment quick start
url: "/on-demand-environments"
- title: GitOps quick starts
- title: 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: On-demand environment quick start
url: "/on-demand-environments"

- title: GitOps quick starts
url: "/gitops-quick-start"
pages:
- title: About GitOps quick starts
url: "/gitops-quick-start"
sub-pages:
- title: Provision a Hosted GitOps Runtime
url: "/install-hosted"
- title: Prepare for Hybrid GitOps Runtime installation
url: "/verify-requirements"
- title: Install a Hybrid GitOps Runtime
url: "/runtime"
- title: Create an application
url: "/create-app-ui"
- title: Create and commit resources for application
url: "/create-app-specs"
- title: Update the image tag for application
url: "/create-rollout"
- title: Work with Environments & Products
url: "/gitops-products"
- title: Create Codefresh account
url: "/create-codefresh-account"
- title: GitOps Runtimes & Git Sources
url: "/gitops-runtimes"
sub-pages:
- title: Preparing for Hybrid GitOps Runtime installation
url: "/verify-requirements"
- title: Installing a Hybrid GitOps Runtime
url: "/runtime"
- title: Creating Git Sources
url: "/create-git-source"
- title: Environments, Products, Applications
url: "/products"
sub-pages:
- title: Creating environments
url: "/quick-start-gitops-environments"
- title: Creating products
url: "/quick-start-product-create"
- title: Creating applications
url: "/create-app-ui"
- title: Exploring the Product Dashboard
url: "/quick-start-product-dashboard"
- title: Promotions
url: "/promotions"
sub-pages:
- title: Drag-and-drop promotion
url: "/drag-and-drop"
- title: Multi-environment sequential promotion
url: "/multi-env-sequential-flow"
- title: Multi-environment promotion with gates
url: "/policy-multi-env-promotion"
- title: Multi-environment parallel promotion
url: "/parallel-multi-env-promotion"
- title: Multi-environment promotion with dependencies
url: "/dependency-multi-env-promotion"

- title: Dashboards & insights
url: "/dashboards"
Expand Down Expand Up @@ -397,23 +418,12 @@
url: "/promotions-overview"
- title: Getting started
url: "/getting-started"
- title: Promotion tutorials
url: "/promotion-scenarios"
- title: Promotion building blocks
url: "/promotion-components"
- title: Promotion setup guidelines
url: "/create-promotion-sequence"
- title: Promotion tutorials
url: "/promotion-scenarios"
sub-pages:
- title: Drag-and-drop
url: "/drag-and-drop"
- title: Multi-environment sequential promotion
url: "/multi-env-sequential-flow"
- title: Multi-environment promotion with conditions
url: "/policy-multi-env-promotion"
- title: Multi-environment promotion with parallel environments
url: "/parallel-multi-env-promotion"
- title: Multi-environment promotion with dependencies
url: "/dependency-multi-env-promotion"
- title: Entity configuration
url: "/entities"
sub-pages:
Expand Down
117 changes: 117 additions & 0 deletions _docs/gitops-quick-start/create-codefresh-account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
---
title: "Creating a Codefresh account"
description: "Start working in Codefresh"
group: gitops-quick-start
redirect_from:
- /docs/getting-started/create-a-codefresh-account/
- /docs/
- /docs/create-an-account/
- /docs/getting-started/
- /docs/getting-started/introduction/
toc: true
---
Once you have installed Codefresh, the next step is to create an account in Codefresh.

After you select the IdP (identity provider), Codefresh requests permission to access your basic details, and for Git providers, to access your Git repositories. The Permissions window that is displayed differs according to the IdP selected.
The permissions requested by Codefresh are needed in order to build and deploy your projects.

## Supported IdPs
Codefresh currently supports the following IdPs:
* GitHub
* Bitbucket
* GitLab
* Azure
* Google
* LDAP

If you need an IdP that is not in the list, please [contact us](https://codefresh.io/contact-us/){:target="\_blank"} with the details.


>**NOTE**
For Git repositories, the login method is less important, as you can access Git repositories through [Git integrations]({{site.baseurl}}/docs/integrations/git-providers/), regardless of your sign-up process. <br><br>
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.

## Create Codefresh account
1. Select the identity provider (IdP) to use:
1. Go to the [Codefresh Sign Up page](https://g.codefresh.io/signup). <!---need to change the URL and the screenshot-->
1. Select the IdP for sign-up.

{% include
image.html
lightbox="true"
file="/images/administration/create-account/select-identity-provider.png"
url="/images/administration/create-account/select-identity-provider.png"
alt="Codefresh sign-up page"
caption="Codefresh sign-up page"
max-width="40%"
%}

{:start="2"}
1. Accept the permissions request for the selected IdP:
* For GitHub: To continue, click **Authorize codefresh-io**.
* For Bitbucket: To continue, click **Grant access**.
* For GitLab: To continue, click **Authorize**.

Once you confirm the permissions for your Git provider, Codefresh automatically connects to your Git provider and fetches your basic account details, such as your email.

{:start="3"}
1. Review the details for your new account, make the relevant changes, and click **NEXT**.

{% include
image.html
lightbox="true"
file="/images/administration/create-account/codefresh-signup.png"
url="/images/administration/create-account/codefresh-signup.png"
alt="Codefresh account details"
caption="Codefresh account details"
max-width="40%"
%}

{:start="4"}
1. Enter a name for your account, and click **NEXT**.

{% include
image.html
lightbox="true"
file="/images/administration/create-account/codefresh-accountname.png"
url="/images/administration/create-account/codefresh-accountname.png"
alt="Codefresh account name"
caption="Codefresh account name"
max-width="40%"
%}

{:start="5"}
1. Finally, answer the questions to personalize your account and click **FINISH**.

{% include
image.html
lightbox="true"
file="/images/administration/create-account/codefresh-personalize.png"
url="/images/administration/create-account/codefresh-personalize.png"
alt="Codefresh personalize account"
caption="Codefresh personalize account"
max-width="40%"
%}

Congratulations! Your new Codefresh account is now ready.

{% include
image.html
lightbox="true"
file="/images/administration/create-account/codefresh-dashboard.png"
url="/images/administration/create-account/codefresh-dashboard.png"
alt="Codefresh dashboard"
caption="Codefresh dashboard"
max-width="40%"
%}


## What's next
Verify that you are ready to install the GitOps Hybrid Runtime, the foundation for GitOps operations.

[Quick start: Preparing for Hybrid GitOps Runtime installation]({{site.baseurl}}/docs/gitops-quick-start/gitops-runtimes/verify-requirements/)





35 changes: 35 additions & 0 deletions _docs/gitops-quick-start/gitops-quick-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: "GitOps quick starts"
description: ""
group: gitops-quick-start
toc: true
redirect_from:
- /docs/quick-start/gitops-quick-start/
---

Codefresh GitOps is all about streamlining application delivery through automation, consistency, and scalability. With Codefresh, you can go from zero to deployment-ready in just a few steps.
The GitOps quick start guides provide step-by-step walkthroughs for you to fully leverage Codefresh GitOps. Starting with account creation, the guides walk you through essential setup leading up to the ultimate goal: deploying and promoting applications seamlessly in your environments.

##### Our quick start walkthroughs

* [Creating an Account]({{site.baseurl}}/docs/gitops-quick-start/create-codefresh-account/)
Get started by setting up your Codefresh account.

* [Installing a GitOps Runtime]({{site.baseurl}}/docs/gitops-quick-start/gitops-runtimes/)
Learn how to install a GitOps Runtime, the single pane of glass component that bridges Git repositories, Kubernetes clusters, applications, and other GitOps entities.

* [Creating environments]({{site.baseurl}}/docs/gitops-quick-start/products/quick-start-gitops-environments/)
Define and manage environments, enabling structured application deployments across different stages.

* [Creating products]({{site.baseurl}}/docs/gitops-quick-start/products/quick-start-product-create/)
Organize related applications under a single product, providing context and control for managing deployments.

* [Creating applications]({{site.baseurl}}/docs/gitops-quick-start/products/create-app-ui/)
Add applications to your product and configure their source repositories, manifests, and deployment paths.

* [Promoting products and applications]({{site.baseurl}}/docs/gitops-quick-start/promotions/)
Deploy, validate, and promote changes across environments through automated promotion flows.

##### From start to deployment
The quick-start journey begins with creating your account and concludes with promotions for applications. Each quick start builds on the last, equipping you with the knowledge and tools to confidently promote and deploy applications in production environments.

35 changes: 35 additions & 0 deletions _docs/gitops-quick-start/gitops-runtimes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: "Quick start: Runtimes & Git Sources in Codefresh GitOps"
description: "Install GitOps Runtime and create Git Sources"
group: gitops-quick-start
toc: true
---





If you have created your account, you can install the GitOps Runtime.

The GitOps Runtime is the cornerstone of Codefresh’s GitOps capabilities, simplifying the complexity of managing deployments at scale with Argo CD. It provides unique benefits that enhance visibility, scalability, and security, making deployment management seamless and efficient.



## Benefits of GitOps Runtimes

* **Unified visibility**
All Argo CD instances are managed through a single control plane, providing comprehensive visibility into all installed Runtimes. The GitOps Runtimes page displays essential details about each Runtime and offers tools for streamlined management.

* E**ffortless maintenance**
Easily track and upgrade Runtime versions. The Runtimes page includes a version column that alerts you when updates are available, with links to detailed changelogs for transparent decision-making.

* **Flexible scalability**
Simplify the management of multiple Argo CD instances by installing additional instances, or scale down by connecting extra remote clusters to an existing GitOps Runtime.



Explore these quick starts to prepare your setup, install a GitOps Runtime, and create a Git source, before you continue with application promotions and deployments.

[Quick start: Preparing for Hybrid GitOps Runtime installation]({{site.baseurl}}/docs/gitops-quick-start/gitops-runtimes/verify-requirements/)
[Quick start: Installing a Hybrid GitOps Runtime]({{site.baseurl}}/docs/gitops-quick-start/gitops-runtimes/runtime/)
[Quick start: Creating a Git Source]({{site.baseurl}}/docs/gitops-quick-start/gitops-runtimes/create-git-source/)
Loading