Skip to content

Update install topics with default git source #1331

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 1 addition & 14 deletions _docs/installation/gitops/runtime-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ After installing a Runtime, complete its configuration to enable GitOps operatio
Configuration includes:
* [Defining Git credentials](#configure-git-credentials-for-runtime)
* [Configuring Runtime as an Argo CD Application](#configure-runtime-as-an-argo-cd-application)
* [Adding a Git source](#add-git-source-to-runtime)


You can configure the Runtime immediately after installation by following the **Configuration and Management** steps in the installation wizard,
or at any time later through the Codefresh UI.
Expand Down Expand Up @@ -64,23 +64,10 @@ Configuring the GitOps Runtime as an Argo CD Application ensures:
* **Visibility and monitoring**
The Runtime appears in the GitOps Apps dashboard, where you can monitor and manage it as any other Argo CD application.

## Add Git Source to Runtime
A **Git Source** is a critical component in GitOps Runtimes, connecting a Git repository to the cluster, enabling deployment and configuration management of Argo CD applications.

The Git repository referenced by the Git Source stores application manifests and other resources which are always synced to the cluster. Codefresh manages the Git Source itself as an Argo CD application.

### Git Source settings

| Setting | Description |
|--------------------------|-------------|
| **Git Source Name** | A unique name for the Git Source within the cluster. Must follow Kubernetes naming conventions. |
| **Git Source Type** | Select **Standard Git Source** to create the Git Source as an Argo CD application in the Runtime's namespace. It belongs to the default or user-defined Application Project, without deployment or repo restrictions. |
| **Git Repository Source** | The Git repository which stores the application manifests, including the Git Source application manifest. Choose one of the following: <br> **Use an existing repository**: <br> - **Repository (Required):** The URL of the Git repository. <br> - **Branch (Optional):** The branch in which to create the Git Source application manifest. <br> - **Path (Optional):** The directory within the repo where the manifest will be stored. <br> **Create a new repository**: <br> - **Organization Name:** Select the organization for which to create the repository. <br> - **Repository Name:** The name of the new repository. |
| **Included and Excluded Files** | Define patterns to specify which files should be included or excluded when syncing the repository to the cluster. Use **GLOB patterns** to define paths: <br> - `workflows/**/*.yaml` → Includes all YAML files in `workflows` and its subdirectories. <br> - `**/images/**/*` → Excludes all directories named `images`. <br> For GLOB guidelines, see this [guide](https://deepsource.io/blog/glob-file-patterns/). |


## Related articles
[Managing Git Sources in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/)
[Managing external clusters in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/)
[Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/)
[Monitoring GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-runtimes/)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,36 @@ where:
Example: `https://github.com/codefresh-io/our-isc.git?ref=isc-branch`

{% if page.collection != site.gitops_collection %}
#### Git providers
### Git providers
On-premises Git providers require you to define the API URL:
* GitHub Enterprise: `https://<server-url>/api/v3`
* GitLab Server: `<server-url>/api/v4`
* Bitbucket Data Center: `<server-url>`
{% endif %}

### Default Git Source

When you install a Runtime, Codefresh GitOps automatically adds a default Standard Git Source to the Shared Configuration Repository.

A Git Source is a core component of GitOps Runtimes. It connects a Git repository to the cluster that stores manifests of Argo CD applications, and enables continuous synchronization.
The Git Source is itself managed as an Argo CD application. Codefresh defines it in the Shared Configuration Repository as a standard Argo CD Application resource, which points to a specific path within the same repository.

Learn more in [Managing Git Sources in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/).

##### Git Source definition
The Git Source is defined in the Shared Configuration Repository as follows:

* **Application manifest path**
Defines the Git Source as an Argo CD application in `resources/<runtime-name>/default-git-source.yaml`.

* **Application `spec.source`**
The `spec.source` for the Git Source application:
* `repoURL`: Shared Configuration Repo
* `path`: Set to `git-sources/<runtime-name>/default`
* `targetRevision`: Shared Configuration repo branch (`isc-repo-branch`)




## Step 3: Install GitOps Runtime

Expand Down
20 changes: 20 additions & 0 deletions _docs/installation/gitops/runtime-install-with-new-argo-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,26 @@ On-premises Git providers require you to define the API URL:
* Bitbucket Data Center: `<server-url>`
{% endif %}

### Default Git Source

When you install a Runtime, Codefresh GitOps automatically adds a default Standard Git Source to the Shared Configuration Repository.

A Git Source is a core component of GitOps Runtimes. It connects a Git repository to the cluster that stores manifests of Argo CD applications, and enables continuous synchronization.
The Git Source is itself managed as an Argo CD application. Codefresh defines it in the Shared Configuration Repository as a standard Argo CD Application resource, which points to a specific path within the same repository.

Learn more in [Managing Git Sources in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/).

##### Git Source definition
The Git Source is defined in the Shared Configuration Repository as follows:

* **Application manifest path**
Defines the Git Source as an Argo CD application in `resources/<runtime-name>/default-git-source.yaml`.

* **Application `spec.source`**
The `spec.source` for the Git Source application:
* `repoURL`: Shared Configuration Repo
* `path`: Set to `git-sources/<runtime-name>/default`
* `targetRevision`: Shared Configuration repo branch (`isc-repo-branch`)


## Step 3: Install GitOps Runtime
Expand Down