Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitf7dae0b

Browse files
committed
Update requirements for images
Added new flow for Image reporting; fixed broken links to Helm charts and packages
1 parent5320dc2 commitf7dae0b

File tree

6 files changed

+55
-26
lines changed

6 files changed

+55
-26
lines changed

‎_docs/deployments/gitops/images.md‎

Lines changed: 40 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,51 @@ sub_group: gitops
66
toc:true
77
---
88

9-
Building Docker images is one of the most basic requirementsfor creating Codefresh pipelines and Argo Workflows.
9+
Building Docker images is one of the most basic requirementsof Codefresh pipelines and Argo Workflows.
1010
Once you create an image, push the image to a registry, and report it to Codefresh, image information is continually updated in the Images page.
1111

12-
##Requirements for Images in Codefresh
12+
If you
13+
14+
##Requirements for images in
15+
16+
Images are pulled to the dashboard
17+
18+
1319
Complete the mandatory steps to see your Images in the Codefresh UI. Each step has links to examples in the Codefresh Hub for Argo.
1420

15-
1. (Mandatory) Build the Docker image, and push the image to any registry.
16-
See[Create a Docker image using Kaniko](https://codefresh.io/argohub/workflow-template/kaniko){:target="\_blank"}.
17-
1. (Optional) Enrich image information with annotations and metadata.
18-
For Git and Jira image enrichment examples, see[Codefresh-metadata image enrichment](https://codefresh.io/argohub/workflow-template/CSDP-metadata){:target="\_blank"}.
19-
1. (Mandatory) Report image information to Codefresh.
20-
See the[report-image-info](https://github.com/codefresh-io/argo-hub/blob/main/workflows/codefresh-csdp/versions/0.0.6/docs/report-image-info.md){:target="\_blank"} example.
21+
1. (Mandatory) Build and push the Docker image
22+
* Codefresh pipelines
23+
Use the`build` step to build a Docker image declaratively in simple or multi-stage Dockerfiles. See[Build step in pipelines]({{site.baseurl}}/docs/pipelines/steps/build/).
24+
25+
The pipeline pushes the image to the default Docker registry.
26+
You can also push the image to any external Docker registry that you integrate with Codefresh. See[Docker Registries for pipeline integrations]({{site.baseurl}}/docs/integrations/docker-registries/).
27+
28+
Review different scenarios for building and pushing Docker images in our[Build/push examples]({{site.baseurl}}/docs/example-catalog/examples/#buildpush-examples).
29+
30+
* GitOps
31+
Create the Docker image.
32+
[Create a Docker image using Kaniko](https://codefresh.io/argohub/workflow-template/kaniko){:target="\_blank"}.
33+
34+
1. (Mandatory) GitOps: Connect to Docker registries
35+
Connect Docker registries to Codefresh to store Docker images.
36+
See[GitOps container registry integrations]({{site.baseurl}}/docs/gitops-integrations/container-registries).
37+
38+
1. (Mandatory) GitOps: Report image information to Codefresh.
39+
This is the equivalent to pushing the image in Codefresh pipelines.
40+
Use the[report-image-info] (https://github.com/codefresh-io/argo-hub/blob/main/workflows/codefresh-csdp/versions/0.0.6/docs/report-image-info.md){:target="\_blank"} DAG template to report image information to Codefresh.
2141

22-
>If you are using an external GitHub Actions-based pipeline, we have a new template that combines image reporting and enrichment. See[Image enrichment with integrations]({{site.baseurl}}/docs/integrations/gitops/image-enrichment-overview/).
42+
>If you are using an external platform or tool for your CI pipelines such as GitHub Actions or Jenkins, or even Codefresh pipelines, we have a new template that combines image reporting and enrichment. See[GitOps CI integrations]({{site.baseurl}}/docs/gitops-integrations/ci-integrations) for details.
43+
44+
1. (Optional) Enrich image with annotations and metadata
45+
Image enrichment exposes metadata such as feature requests, pull requests, and logs as part of the application’s deployment, for visibility into all aspects of the deployment, making it easier to track actions and identify root cause of failures.
46+
* Codefresh pipelines
47+
See[Docker image metadata]({{site.baseurl}}/docs/pipelines/docker-image-metadata/)
48+
* GitOps
49+
See[GitOps issue tracking integrations]({{site.baseurl}}/docs/gitops-integrations/issue-tracking) and[Jira]({{site.baseurl}}/docs/gitops-integrations/issue-tracking/jira) integration.
50+
51+
2352

24-
##Image views in Codefresh
53+
##Images dashboard
2554
* In the Codefresh UI, from Artifacts in the sidebar, select[Images](https://g.codefresh.io/2.0/images){:target="\_blank"}.
2655

2756
Image views are layered to show three levels of data:
@@ -30,7 +59,7 @@ Image views are layered to show three levels of data:
3059
* Summary with metadata and binary information
3160

3261
###Filters for Image views
33-
As with any resource in Codefresh,image views support filters that allow you focus on the data that's important to you.
62+
As with any resource in Codefresh,the Image dashboard support filters that allow you focus on the data that's important to you.
3463
Most image filters support multi-selection. Unless otherwise indicated, the filters are common to all view levels.
3564

3665
{: .table .table-bordered .table-hover}

‎_docs/deployments/helm/custom-helm-uploads.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ toc: true
1111
Helm packages are just TAR files. Helm repositories are simple file hierarchies with an extra[index.yaml](https://helm.sh/docs/developing_charts/#the-chart-repository-structure){:target="\_blank"}.
1212
You can run custom commands and manually upload indexes and packages to a Helm repo.
1313

14-
>Thisarticles shows some non-standard Helm examples.
14+
>Thisarticle shows some non-standard Helm examples.
1515
For the basic use cases, or if you are just getting started with Helm, see our[Helm quick start guide]({{site.baseurl}}/docs/quick-start/ci-quickstart/deploy-with-helm/) and[Using Helm in pipelines]({{site.baseurl}}/docs/deployments/helm/using-helm-in-codefresh-pipeline/).
1616

1717
##Package a Helm chart
@@ -28,7 +28,7 @@ helm_package:
2828
{% endhighlight %}
2929

3030
The`helm package` command expects a path to an unpacked chart. Replace`<mychart>` in the example with the directory that holds your chart files. Note that this directory must have the same name as the chart name, as per Helm requirements.<br>
31-
See[Helm package docs](https://github.com/kubernetes/helm/blob/master/docs/helm/helm_package.md){:target="_blank"} and[Helm charts overview](https://github.com/kubernetes/helm/blob/master/docs/charts.md){:target="_blank"} for more information.
31+
See[Helm package docs](https://helm.sh/docs/helm/helm_package/){:target="_blank"} and[Helm charts overview](https://helm.sh/docs/topics/charts/){:target="_blank"} for more information.
3232

3333
{{site.data.callout.callout_info}}
3434
To use`cf_export`and make the variable available to other steps in the pipeline, see [Variables in pipelines]({{site.baseurl}}/docs/pipelines/variables).

‎_docs/deployments/helm/helm-releases-management.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,10 +171,10 @@ max-width="50%"
171171

172172
From the main release screen, you have some additional actions.
173173

174-
You can issue a Helm test<!--- [Helm test](https://github.com/kubernetes/helm/blob/master/docs/chart_tests.md)--> by clicking onthe'Run Test' button onthe desired chart row.
175-
176-
You can deletea release by clicking on the 'Delete' button on the desired chart row.
177-
<!---For deletion options, see the [helm delete documentation](https://github.com/kubernetes/helm/blob/master/docs/helm/helm_delete.md){:target="\_blank"}, for example, *purge*will removethe revision from the release history.-->
174+
Selecttherow withthe desired chart, and:
175+
* Issue a[Helm test](https://helm.sh/docs/topics/chart_tests/){:target="\_blank"} by clicking on the 'Run Test' button.
176+
* Deletea release by clicking on the 'Delete' button.
177+
For deletion options, see the[Helm delete documentation](https://helm.sh/docs/helm/helm_uninstall/){:target="\_blank"}. For example,*purge*removesthe revision from the release history.
178178

179179
##Helm deployment badge<!--how to add badge ask where is the badge icon-->
180180

‎_docs/deployments/kubernetes/deployment-options-to-kubernetes.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ Using this YAML example, we'll add an additional step to deploy the image in Doc
5858

5959
##Describe your deployment
6060
The following instructions describe how to create a new service in your Kubernetes cluster in order to deploy to it.
61-
<!--- >If you're deployingto an existing service in your Kubernetes cluster,please skip to the [nextstep]({{site.baseurl}}/docs/getting-started/deployment-to-kubernetes-quick-start-guide/#add-a-deployment-step).-->
61+
>To deployto an existing service in your Kubernetes cluster,see[Add a deploymentstep](#add-a-deployment-step).
6262
6363

64-
1.Go tothe**`Kubernetes`&#8594;`Services page`**.
65-
1. Click the button**Add Service**.
64+
1.In the Codefresh UI, from Ops inthesidebar, select[**KubernetesServices**](https://g.codefresh.io/kubernetes/services/){:target="\_blank"}.
65+
1. Click the button**Add Service**.
6666
1. Select the**cluster**.
6767
1. Select the**namespace**.
6868
1. Type an arbitrary**service name**.

‎_docs/getting-started/ci-codefresh.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ See [Slack notifications in Codefresh]({{site.baseurl}}/docs/integrations/notifi
121121
**Jira notifications**
122122
Codefresh integrates with Jira in several ways:
123123
The standard integration provides the highest visibility into your GitOps deployments. Referencing the integration in your pipeline pulls in all the Jira information and enriches the image with the issue-tracking information.
124-
Our versatile[Jira Issue Manager](https://codefresh.io/steps/step/jira-issue-manager?__hstc=13221992.d6be31528e6c55e9c8e25cbf4f7ec143.1637822320970.1673765905554.1673785426249.294&__hssc=13221992.18.1673785426249&__hsfp=1203046529{:target="\_blank"} step can be used to create Jira issues, comment on existing Jira issues, change the status of an issue, and even add a description to your issue.
124+
Our versatile[Jira Issue Manager](https://codefresh.io/steps/step/jira-issue-manager){:target="\_blank"} step can be used to create Jira issues, comment on existing Jira issues, change the status of an issue, and even add a description to your issue.
125125

126126

127127
See[Jira notifications in Codefresh]({{site.baseurl}}/docs/integrations/notifications/jira-integration/) and[examples for Jira notification]({{site.baseurl}}/docs/example-catalog/ci-examples/sending-the-notification-to-jira/).

‎_docs/integrations/google-marketplace.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ toc: true
66
---
77

88
Codefresh has partnered with[Google Cloud](https://cloud.google.com/){:target="\_blank"} and allows you to install a Codefresh pipeline builder within your own Kubernetes cluster.
9-
The integration is available in the Google Marketplace for Kubernetes apps at[https://console.cloud.google.com/marketplace/details/codefresh-gke/codefresh](https://console.cloud.google.com/marketplace/details/codefresh-gke/codefresh){:target="\_blank"}.
9+
The integration is available in the Google Marketplace for Kubernetes apps at[https://console.cloud.google.com/marketplace/product/codefresh-gke/codefresh-saas](https://console.cloud.google.com/marketplace/product/codefresh-gke/codefresh-saas){:target="\_blank"}.
1010

1111
Once you configure Codefresh to use your own Kubernetes cluster for builds, you can enjoy all benefits of a**hybrid** installation as the Codefresh UI and management dashboards will still run in a SAAS manner, while the actual builds and pipelines will execute in your own cluster.
1212

@@ -24,7 +24,7 @@ To start the integration, you need the following:
2424
1. A[GKE cluster](https://cloud.google.com/kubernetes-engine/docs/quickstart){:target="\_blank"} that will run all builds and pipelines
2525
1. A[Codefresh account]({{site.baseurl}}/docs/administration/account-user-management/create-a-codefresh-account/) (creating an account is free, you pay only for builds)
2626

27-
Then visit the Codefresh GKE page at[https://console.cloud.google.com/marketplace/details/codefresh-gke/codefresh](https://console.cloud.google.com/marketplace/details/codefresh-gke/codefresh){:target="\_blank"}.
27+
Then visit the Codefresh GKE page at[https://console.cloud.google.com/marketplace/product/codefresh-gke/codefresh-saas](https://console.cloud.google.com/marketplace/product/codefresh-gke/codefresh-saas){:target="\_blank"}.
2828

2929
##Using Codefresh from the Google Marketplace
3030

@@ -52,7 +52,7 @@ To start using the service, you need to [enable billing](https://cloud.google.co
5252

5353
You will pay for the cluster resources to Google, plus the Codefresh builds. Codefresh does not collect any payment from you directly. Google Cloud will invoice you for both the cluster infrastructure and the cluster usage.
5454

55-
Current pricing for Codefresh builds is always shown in the[marketplace page](https://console.cloud.google.com/marketplace/details/codefresh-gke/codefresh){:target="\_blank"}.
55+
Current pricing for Codefresh builds is always shown in the[marketplace page](https://console.cloud.google.com/marketplace/product/codefresh-gke/codefresh-saas){:target="\_blank"}.
5656

5757
##Install the Google Marketplace
5858

@@ -80,7 +80,7 @@ With the token at hand, we can go to the Google marketplace.
8080

8181
###Step 2: Install the Codefresh application in your Google Cloud cluster
8282

83-
1. Navigate to[https://console.cloud.google.com/marketplace/details/codefresh-gke/codefresh](https://console.cloud.google.com/marketplace/details/codefresh-gke/codefresh){:target="\_blank"}.
83+
1. Navigate to[https://console.cloud.google.com/marketplace/product/codefresh-gke/codefresh-saas](https://console.cloud.google.com/marketplace/details/codefresh-gke/codefresh){:target="\_blank"}.
8484
1. From the dropdown menu at the top of the page, select a Google project that has billing enabled.
8585
1. Click**Configure**.
8686

@@ -233,7 +233,7 @@ caption="Removing the Codefresh application"
233233
alt="Removing the Codefresh application"
234234
%}
235235

236-
You can install the Codefresh builder again from the[marketplace](https://console.cloud.google.com/marketplace/details/codefresh-gke/codefresh){:target="\_blank"}.
236+
You can install the Codefresh builder again from the[marketplace](https://console.cloud.google.com/marketplace/product/codefresh-gke/codefresh-saas){:target="\_blank"}.
237237

238238
##Related articles
239239
[Manage your cluster]({{site.baseurl}}/docs/deployments/kubernetes/manage-kubernetes/)

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp