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

feat: Add ArgoHub documentation and navigation structure (POC) #1134

Open
wants to merge 15 commits 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
1 change: 1 addition & 0 deletions _argohub/introduction/intro-to-codefresh.md
7 changes: 7 additions & 0 deletions _argohub/introduction/some-new-doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "ArgHub Info"
description: "This is some info doc for argohub only"
toc: true
---

## Some secret data for ArgoHub only
1 change: 1 addition & 0 deletions _argohub/quick-start/gitops-quick-start/runtime.md
11 changes: 11 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@ collections:
docs:
output: true
permalink: /:collection/:path/
argohub:
output: true
permalink: /:collection/:path/

# Defaults
defaults:
Expand All @@ -109,6 +112,14 @@ defaults:
layout: docs
toc: true
wide: true
# _argohub
- scope:
path: "_argohub"
type: argohub
values:
layout: argohub
toc: true
wide: true

# #RSS Feed Location
feed:
Expand Down
81 changes: 81 additions & 0 deletions _data/argohub-nav.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
- title: ArgoHub Introduction
url: "/introduction"
pages:
- title: What is Codefresh?
url: "/intro-to-codefresh"
- title: Only for ArgoHub
url: "/some-new-doc"


- title: Installation
url: "/installation"
pages:
- title: GitOps Runtimes
url: "/gitops"
- title: Platform deployment
url: "/installation-options"

- title: GitOps Runtimes
url: "/gitops-runtime"
pages:
- title: What's changed in GitOps Runtimes
url: "/gitops-runtimes-whats-changed"
- title: About GitOps Runtimes
url: "/gitops-runtime"
- title: GitOps Runtime architecture
url: "/runtime-architecture"
- title: Runtime essentials
url: "/runtime-concepts"
- title: System requirements & prerequisites
url: "/runtime-system-requirements"
- title: Ingress controller configuration
url: "/runtime-ingress-configuration"
- title: Install Hybrid GitOps Runtime
url: "/hybrid-gitops-helm-installation"
- title: Install Hybrid GitOps Runtime alongside Community Argo CD
url: "/argo-with-gitops-side-by-side"
- title: Migrating Hybrid GitOps Runtimes from CLI to Helm
url: "/migrate-cli-runtimes-helm"
- title: Monitoring & managing GitOps Runtimes
url: "/monitor-manage-runtimes"
- title: Shared Configuration Repository
url: "/shared-configuration"
- title: Managing external clusters in GitOps Runtimes
url: "/managed-cluster"
- title: Managing Git Sources in GitOps Runtimes
url: "/git-sources"


- title: Quick starts
url: "/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
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"
51 changes: 30 additions & 21 deletions _data/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -588,27 +588,36 @@
url: "/install-codefresh-runner"
- title: Runner installation behind firewalls
url: "/behind-the-firewall"
- title: GitOps Runtimes
url: "/gitops"
sub-pages:
- title: GitOps Runtime architecture
url: "/runtime-architecture"
- title: Hybrid GitOps Runtime
url: "/hybrid-gitops-helm-installation"
- title: Hybrid GitOps Runtime alongside Community Argo CD
url: "/argo-with-gitops-side-by-side"
- title: On-premises GitOps Runtime
url: "/on-prem-gitops-runtime-install"
- title: Migrating Hybrid GitOps Runtimes from CLI to Helm
url: "/migrate-cli-runtimes-helm"
- title: Shared Configuration Repository
url: "/shared-configuration"
- title: Monitoring & managing GitOps Runtimes
url: "/monitor-manage-runtimes"
- title: Managing external clusters in GitOps Runtimes
url: "/managed-cluster"
- title: Managing Git Sources in GitOps Runtimes
url: "/git-sources"

- title: GitOps Runtimes
url: "/gitops-runtime"
pages:
- title: What's changed in GitOps Runtimes
url: "/gitops-runtimes-whats-changed"
- title: About GitOps Runtimes
url: "/gitops-runtime"
- title: GitOps Runtime architecture
url: "/runtime-architecture"
- title: Runtime essentials
url: "/runtime-concepts"
- title: System requirements & prerequisites
url: "/runtime-system-requirements"
- title: Ingress controller configuration
url: "/runtime-ingress-configuration"
- title: Install Hybrid GitOps Runtime
url: "/hybrid-gitops-helm-installation"
- title: Install Hybrid GitOps Runtime alongside Community Argo CD
url: "/argo-with-gitops-side-by-side"
- title: Migrating Hybrid GitOps Runtimes from CLI to Helm
url: "/migrate-cli-runtimes-helm"
- title: Monitoring & managing GitOps Runtimes
url: "/monitor-manage-runtimes"
- title: Shared Configuration Repository
url: "/shared-configuration"
- title: Managing external clusters in GitOps Runtimes
url: "/managed-cluster"
- title: Managing Git Sources in GitOps Runtimes
url: "/git-sources"


- title: Administration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ max-width="70%"
%}

## Related articles
[Connect Git provider]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/#2-connect-git-provider)
[Connect Git provider]({{site.baseurl}}/docs/gitops-runtime/hosted-runtime/#2-connect-git-provider)
4 changes: 2 additions & 2 deletions _docs/deployments/gitops/applications-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Here's a description of the information and actions you can see for individual a
{: .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} <ul><li>Application health<br>A snapshot that displays a breakdown of the deployed applications by their health status.<br>Click a status to filter by applications that match it.<br>Codefresh tracks Argo CD's set of health statuses. See <a href="https://codefresh.io/docs/docs/deployments/gitops/applications-dashboard/#health-status-for-application-resources">Health status</a> in this article, and Argo CD's official documentation on <a href="https://argo-cd.readthedocs.io/en/stable/operator-manual/health" target=”_blank”>Health sets</a>.</li><li>Application attributes<br>Attribute filters support multi-selection, and results are based on an OR relationship within the same filter with multiple options, and an AND relationship between filters.<br>Clicking <b>More Filters</b> gives you options to filter by Health status, Cluster names, Namespace, and Type. <br><ul><li>Application Type: Can be any of the following<ul><li>Applications: Standalone applications. See the official documentation on <a href="https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/#applications" target=”_blank”>Applications</a>.</li><li>ApplicationSet: Applications created using the ApplicationSet Custom Resource (CR) template. An ApplicationSet can generate single or multiple applications. See the official documentation on <a href="https://argo-cd.readthedocs.io/en/stable/user-guide/application-set" target=”_blank”>Generating Applications with ApplicationSet</a>.</li><li>Git Source: Applications created by Codefresh that includes other applications and CI resources. See <a href="https://codefresh.io/docs/docs/installation/gitops/git-sources/">Git Sources</a>.</li></ul></li></li><li>Labels:The K8s labels defined for the applications. The list displays labels of <i>all</i> the applications, even if you have applied filters.<br>To see the available labels, select <b>Add</b>, and then select the required label and one or more values. <br>To filter by the labels, select <b>Add</b> and then <b>Apply</b>.<br> See the official documentation on <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/labels" target=”_blank”>Labels and selectors</a>.</li></ul></ul>{:/}|
|**Application filters** | Filter by a range of attributes to customize the information in the dashboard to bring you what you need. {::nomarkdown} <ul><li>Application health<br>A snapshot that displays a breakdown of the deployed applications by their health status.<br>Click a status to filter by applications that match it.<br>Codefresh tracks Argo CD's set of health statuses. See <a href="https://codefresh.io/docs/docs/deployments/gitops/applications-dashboard/#health-status-for-application-resources">Health status</a> in this article, and Argo CD's official documentation on <a href="https://argo-cd.readthedocs.io/en/stable/operator-manual/health" target=”_blank”>Health sets</a>.</li><li>Application attributes<br>Attribute filters support multi-selection, and results are based on an OR relationship within the same filter with multiple options, and an AND relationship between filters.<br>Clicking <b>More Filters</b> gives you options to filter by Health status, Cluster names, Namespace, and Type. <br><ul><li>Application Type: Can be any of the following<ul><li>Applications: Standalone applications. See the official documentation on <a href="https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/#applications" target=”_blank”>Applications</a>.</li><li>ApplicationSet: Applications created using the ApplicationSet Custom Resource (CR) template. An ApplicationSet can generate single or multiple applications. See the official documentation on <a href="https://argo-cd.readthedocs.io/en/stable/user-guide/application-set" target=”_blank”>Generating Applications with ApplicationSet</a>.</li><li>Git Source: Applications created by Codefresh that includes other applications and CI resources. See <a href="https://codefresh.io/docs/docs/gitops-runtime/git-sources/">Git Sources</a>.</li></ul></li></li><li>Labels:The K8s labels defined for the applications. The list displays labels of <i>all</i> the applications, even if you have applied filters.<br>To see the available labels, select <b>Add</b>, and then select the required label and one or more values. <br>To filter by the labels, select <b>Add</b> and then <b>Apply</b>.<br> See the official documentation on <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/labels" target=”_blank”>Labels and selectors</a>.</li></ul></ul>{:/}|
|{::nomarkdown}<img src="../../../../images/icons/icon-mark-favorite.png?display=inline-block">{:/}| Star applications as favorites and view only the starred applications.{::nomarkdown}<br>Select the <img src="../../../../images/icons/icon-mark-favorite.png?display=inline-block"> to star the application as a favorite.<br><br>To filter by favorite applications, on the filters bar, select <img src="../../../../images/icons/icon-fav-starred.png?display=inline-block">.<br>{:/} TIP: If you star applications as favorites in the GitOps Apps dashboard, you can filter by the same applications in the [DORA metrics dashboard]({{site.baseurl}}/docs/dashboards/dora-metrics/#metrics-for-favorite-applications). |
|**Application actions**| Options to monitor/manage applications through the application's context menu. {::nomarkdown}<ul><li>Quick view<br>A comprehensive read-only view of the deployment and definition information for the application.</li>{:/}See [Monitor deployments for selected Argo CD application](#monitoring-deployments-for-selected-argo-cd-application) in this article.{::nomarkdown}<li>Synchronize/Sync<br>Manually synchronize the application.</li>{:/}See [Manually sync applications]({{site.baseurl}}/docs/deployments/gitops/manage-application/#manually-synchronize-an-argo-cd-application).{::nomarkdown}<li>Edit<br>Modify application definitions.</li>{:/}See [Edit application definitions]({{site.baseurl}}/docs/deployments/gitops/manage-application/#edit-argo-cd-application-definitions).{::nomarkdown}<li>Refresh and Hard Refresh: Always available in the application's toolbar. <ul><li>Refresh: Retrieve desired (Git) state, compare with the live (cluster) state, and refresh the application to sync with the desired state.</li><li>Hard Refresh: Refresh the application to sync with the Git state, while removing the cache.</li></ul>See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#refreshhard-refresh-argo-cd-applications/">Refresh/hard refresh GitOps applications</a>.{:/} |

Expand Down Expand Up @@ -370,7 +370,7 @@ Every resource has a context menu that opens on clicking the three dots on the r

{{site.data.callout.callout_tip}}
**TIP**
If you have deep links configured for applications/resources for Hybrid GitOps Runtimes, these are also displayed in the context menu. To configure deep links in Codefresh, see [(Hybrid GitOps) Configure Deep Links to applications & resources]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#hybrid-gitops-configure-deep-links-to-applications--resources).
If you have deep links configured for applications/resources for Hybrid GitOps Runtimes, these are also displayed in the context menu. To configure deep links in Codefresh, see [(Hybrid GitOps) Configure Deep Links to applications & resources]({{site.baseurl}}/docs/gitops-runtime/monitor-manage-runtimes/#hybrid-gitops-configure-deep-links-to-applications--resources).
{{site.data.callout.end}}


Expand Down
6 changes: 3 additions & 3 deletions _docs/deployments/gitops/create-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The Create application wizard guides you through the process of creating an appl

For example Argo CD applications, see this [repo](https://github.com/oleksandr-codefresh/argocd-example-apps){:target="_blank"}.

Remember you need a valid [Git Source]({{site.baseurl}}/docs/installation/gitops/git-sources/) to be able to create and commit an Argo CD application.
Remember you need a valid [Git Source]({{site.baseurl}}/docs/gitops-runtime/git-sources/) to be able to create and commit an Argo CD application.

Once created and synced to clusters, Argo CD applications are displayed in the GitOps Apps dashboard. Here, you can [monitor]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/) and [manage]({{site.baseurl}}/docs/deployments/gitops/manage-application/) individual Argo CD applications.

Expand Down Expand Up @@ -71,7 +71,7 @@ Select an existing group or groups, or create a new application group by typing

### Source
The Git repository to be tracked for changes to the application's source code.
{::nomarkdown}<ul> <li><b>Repository URL</b>: The Git repo or the Helm package repo with the application source code, to be tracked for changes. <br>If SSH is configured for the runtime, you can connect to the repo with either HTTPS or SSH. On selecting the repository, Codefresh automatically updates the URL format. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#configure-ssh-for-gitops-runtimes">Configure SSH for runtimes</a>.<br>If the Argo CD project is not the <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">default</span> project, make sure that the repo has the correct access roles for your application.<ul><li><b>Revision and Path</b>: Applies to Git repositories. </li><li><b>Chart</b>: Applies to Helm repositories. The name of the Helm package with all the resource definitions for the application, and the version. </li></ul>For more information, see <a href="https://argo-cd.readthedocs.io/en/stable/user-guide/tracking_strategies/" target="\_blank">Tracking and Deployment Strategies</a>.</li></ul>{:/}
{::nomarkdown}<ul> <li><b>Repository URL</b>: The Git repo or the Helm package repo with the application source code, to be tracked for changes. <br>If SSH is configured for the runtime, you can connect to the repo with either HTTPS or SSH. On selecting the repository, Codefresh automatically updates the URL format. See <a href="https://codefresh.io/docs/docs/gitops-runtime/monitor-manage-runtimes/#configure-ssh-for-gitops-runtimes">Configure SSH for runtimes</a>.<br>If the Argo CD project is not the <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">default</span> project, make sure that the repo has the correct access roles for your application.<ul><li><b>Revision and Path</b>: Applies to Git repositories. </li><li><b>Chart</b>: Applies to Helm repositories. The name of the Helm package with all the resource definitions for the application, and the version. </li></ul>For more information, see <a href="https://argo-cd.readthedocs.io/en/stable/user-guide/tracking_strategies/" target="\_blank">Tracking and Deployment Strategies</a>.</li></ul>{:/}



Expand Down Expand Up @@ -171,7 +171,7 @@ Create a new application from the GitOps Apps dashboard with the Add Application
Edit the manifest directly in YAML mode, or define the settings in the Form mode. Toggle between the modes as convenient. You can also edit the YAML manifest directly at all stages, after defining configuration settings, and before the final commit.

**Before you begin**
* Make sure you have a valid [Git Source]({{site.baseurl}}/docs/installation/gitops/git-sources/)
* Make sure you have a valid [Git Source]({{site.baseurl}}/docs/gitops-runtime/git-sources/)

* Review:
[General configuration](#application-general-configuration-settings)
Expand Down
2 changes: 1 addition & 1 deletion _docs/deployments/gitops/install-argo-rollouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ If Argo Rollouts has not been installed, an **Install Argo Rollouts** button is
%}

## Related articles
[Managing external clusters in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/)
[Managing external clusters in GitOps Runtimes]({{site.baseurl}}/docs/gitops-runtime/managed-cluster/)
6 changes: 3 additions & 3 deletions _docs/getting-started/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@ A single Runtime can connect to and manage multiple remote clusters.


See:
[GitOps runtime architecture]({{site.baseurl}}/docs/installation/gitops/runtime-architecture/)
[Hybrid GitOps Runtime installation]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/)
[Hosted GitOps Runtime installation]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/)
[GitOps runtime architecture]({{site.baseurl}}/docs/gitops-runtime/runtime-architecture/)
[Hybrid GitOps Runtime installation]({{site.baseurl}}/docs/gitops-runtime/hybrid-gitops-helm-installation/)
[Hosted GitOps Runtime installation]({{site.baseurl}}/docs/gitops-runtime/hosted-runtime/)


## Triggers
Expand Down
Loading