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

Commit673cf40

Browse files
committed
Add incubation topics to projectone
Added missing incubation topics, screenshots, redirects, and updated home and nav yamls
1 parent29e35de commit673cf40

File tree

12 files changed

+359
-1
lines changed

12 files changed

+359
-1
lines changed

‎_data/home-content.yml‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,16 @@
277277
localurl:/docs/reference/shared-configuration/
278278

279279

280-
280+
-title:"Incubation"
281+
icon:images/home-icons/plugins.svg
282+
url:''
283+
links:
284+
-title:Windows Containers Support
285+
localurl:/docs/incubation/windows
286+
-title:Mac OSX and iOS builds
287+
localurl:/docs/incubation/osx-ios-builds
288+
-title:ARM architecture Support
289+
localurl:/docs/incubation/arm-support
281290

282291

283292

‎_data/nav.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -592,6 +592,15 @@
592592
-title:Documentation changes
593593
url:"/doc-changes"
594594

595+
-title:Incubation
596+
url:"/incubation"
597+
pages:
598+
-title:Windows Container Support Overview
599+
url:"/windows"
600+
-title:Mac OSX and iOS builds
601+
url:"/osx-ios-builds"
602+
-title:ARM architecture support
603+
url:"/arm-support"
595604

596605
-title:Troubleshooting
597606
url:"/troubleshooting"

‎_docs/incubation/arm-support.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
title:"ARM Support"
3+
description:"Use Docker containers on ARM architecture"
4+
group:incubation
5+
redirect_from:
6+
-/docs/incubation/arm-support/
7+
toc:true
8+
---
9+
10+
Codefresh is offering initial support for building Docker images for the ARM architecture. ARM support
11+
is only available to Enterprise customers.
12+
13+
##Enabling ARM support
14+
15+
To run ARM pipelines in Codefresh,[open a free account]({{site.baseurl}}/docs/administration/account-user-management/create-codefresh-account/) and then[contact sales](https://codefresh.io/contact-us/){:target="\_blank"} in order to enable ARM support.
16+
17+
>Due to unforeseen circumstances, we are currently unable to support ARM builds on our SaaS infrastructure. We apologize for the inconvenience.
18+
19+
Once approved, you will get access to a new runtime environment installed on an ARM cluster. This means that you will be able to run both ARM and Linux/x86 builds from the same Codefresh account by choosing the appropriate[pipeline settings]({{site.baseurl}}/docs/pipelines/pipelines/#pipeline-settings).
20+
21+
##Using ARM builders in Codefresh
22+
23+
Once ARM support is enabled for your account, there is no other special requirement to start building ARM images.
24+
25+
Just read the Codefresh documentation:
26+
27+
*[Introduction to Pipelines]({{site.baseurl}}/docs/pipelines/introduction-to-codefresh-pipelines/)
28+
*[Creating a Pipeline]({{site.baseurl}}/docs/pipelines/pipelines/)
29+
*[Codefresh YAML]({{site.baseurl}}/docs/pipelines/what-is-the-codefresh-yaml/)
30+
*[Working with Docker registries]({{site.baseurl}}/docs/ci-cd-guides/working-with-docker-registries/)
31+
*[On demand environments]({{site.baseurl}}/docs/quick-start/ci-quick-start/on-demand-environments/)
32+
33+
34+
The only important thing to notice is to make sure that the base Docker images you use are ARM-compiled.
35+
36+
Most popular Docker images (i.e., Alpine) already offer ARM support so all your builds should work right away.
37+
38+
{% include
39+
image.html
40+
lightbox="true"
41+
file="/images/incubation/arm-support/arm-support.png"
42+
url="/images/incubation/arm-support/arm-support.png"
43+
alt="Checking for ARM images in Dockerhub"
44+
caption="Checking for ARM images in Dockerhub"
45+
max-width="60%"
46+
%}
47+
48+
Dockerhub has a lot of public images that are offered in multiple architectures.
49+
You will get errors only if you use a less popular image that has no ARM support.
50+
51+
52+
53+
##Example for an ARM build
54+
55+
The[Python sample application](https://github.com/codefresh-contrib/python-flask-sample-app){:target="\_blank"} used in the[quick start guide]({{site.baseurl}}/docs/quick-start/ci-quick-start/create-ci-pipeline/) is based on an official Docker image that already has ARM support.
56+
57+
Create a pipeline for it with the following YAML content:
58+
59+
`codefresh.yml`
60+
{% highlight yaml %}
61+
{% raw %}
62+
version: '1.0'
63+
steps:
64+
main_clone:
65+
title: 'Cloning main repository...'
66+
type: git-clone
67+
repo: '${{CF_REPO_OWNER}}/${{CF_REPO_NAME}}'
68+
revision: '${{CF_REVISION}}'
69+
git: github
70+
MyArmDockerImage:
71+
title: Building Docker ARM Image
72+
type: build
73+
image_name: python-flask-sampleapp-arm
74+
tag: '${{CF_BRANCH_TAG_NORMALIZED}}'
75+
dockerfile: Dockerfile
76+
MyUnitTests:
77+
title: Running Unit tests
78+
image: ${{MyArmDockerImage}}
79+
commands:
80+
- uname -a
81+
- python setup.py test
82+
{% endraw %}
83+
{% endhighlight %}
84+
85+
This pipeline creates a Docker image for a python application and then runs unit tests inside it.
86+
87+
It contains three[steps]({{site.baseurl}}/docs/codefresh-yaml/steps/):
88+
89+
1. A[clone step]({{site.baseurl}}/docs/pipelines/steps/git-clone/) that checks out code from the Git repository.
90+
1. A[build step]({{site.baseurl}}/docs/pipelines/steps/build/) that reads a Dockerfile and creates a Docker image.
91+
1. A[freestyle step]({{site.baseurl}}/docs/pipelines/steps/freestyle/) that runs unit tests.
92+
93+
The logs verify that this is an ARM image:
94+
95+
{% include
96+
image.html
97+
lightbox="true"
98+
file="/images/incubation/arm-support/logs-arm.png"
99+
url="/images/incubation/arm-support/logs-arm.png"
100+
alt="Running Unit tests"
101+
caption="Running Unit tests"
102+
max-width="60%"
103+
%}
104+
105+
Once the pipeline is finished you will see the Docker image stored in the[default Docker Registry]({{site.baseurl}}/docs/docker-registries/external-docker-registries/#the-default-registry):
106+
107+
{% include
108+
image.html
109+
lightbox="true"
110+
file="/images/incubation/arm-support/arm-images.png"
111+
url="/images/incubation/arm-support/arm-images.png"
112+
alt="Private Registry for ARM docker images"
113+
caption="Private Registry for ARM docker images"
114+
max-width="60%"
115+
%}
116+
117+
You can also launch it as a[demo environment]({{site.baseurl}}/docs/quick-start/ci-quick-start/on-demand-environments/).
118+
119+
{% include
120+
image.html
121+
lightbox="true"
122+
file="/images/incubation/arm-support/arm-environment.png"
123+
url="/images/incubation/arm-support/arm-environment.png"
124+
alt="Launching Docker ARM images"
125+
caption="Launching Docker ARM images"
126+
max-width="60%"
127+
%}
128+
129+
In summary, the workflow for ARM images is exactly the same as the usual Linux/x86 images.
130+
131+
##Related articles
132+
[Windows container support]({{site.baseurl}}/docs/incubation/windows-beta/)
133+
[macOS and iOS builds]({{site.baseurl}}/docs/incubation/osx-ios-builds/)
134+

‎_docs/incubation/osx-ios-builds.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
---
2+
title:"macOS and iOS builds"
3+
description:"Using Codefresh for Mac/iPhone applications"
4+
group:incubation
5+
redirect_from:
6+
-/docs/incubation/osx-ios-builds/
7+
toc:true
8+
---
9+
10+
Codefresh offers alpha support for macOS and/or iOS as a CI/CD environment. Access to the build environment is possible by invitation only. To run macOS/iOS pipelines in Codefresh,[open a free account]({{site.baseurl}}/docs/administration/account-user-management/create-codefresh-account/) and then[contact sales](https://codefresh.io/contact-us/){:target="\_blank"} in order to enable this build environment type.
11+
12+
>macOS/iOS builds are only available for the SaaS platform. They are not available for the Hybrid platform at this time.
13+
14+
##Enabling macOS/iOS support
15+
16+
Once approved, you will get access to a special runtime environment that will run your macOS/iOS builds. To use this environment[create a new pipeline]({{site.baseurl}}/docs/pipelines/pipelines/) and select it in the pipeline settings screen.
17+
18+
{% include
19+
image.html
20+
lightbox="true"
21+
file="/images/incubation/osx-builds/osx-build-settings.png"
22+
url="/images/incubation/osx-builds/osx-build-settings.png"
23+
alt="Running a pipeline on the macOS environment"
24+
caption="Running a pipeline on the macOS environment"
25+
max-width="60%"
26+
%}
27+
28+
The macOS runtime environment has Xcode already installed for your iOS and/or macOS builds.
29+
30+
##Building macOS/iOS applications with Codefresh
31+
32+
Once you assign the special macOS runtime to your pipeline, you can write your[Codefresh YAML]({{site.baseurl}}/docs/pipelines/what-is-the-codefresh-yaml/) as usual, keeping in mind the following points
33+
34+
* The git-clone step is available
35+
* Freestyle steps must use the`freestyle-ssh` type
36+
* The manual approval step is available
37+
* All Docker-related pipeline steps such build, push, deploy, composition are**NOT** available.
38+
* Parallel steps are supported
39+
* Only one active build is supported at any given time.
40+
41+
As part of the alpha version the nodes that run your macOS builds are actual nodes (i.e. not containers), so all changes you make there are permanent. This is a temporary limitation of the current Alpha release and will not be present in the General Availability version of the build service.
42+
43+
##macOS build pipeline example
44+
45+
You can find a full Codefresh example at[https://github.com/alex-codefresh/osx-demo-webserver](https://github.com/alex-codefresh/osx-demo-webserver){:target="\_blank"}.
46+
47+
Create a pipeline for it with the following YAML content:
48+
49+
`codefresh.yml`
50+
{% highlight yaml %}
51+
{% raw %}
52+
version: '1.0'
53+
stages:
54+
- 'Clone Repo'
55+
- 'Test & Build'
56+
- 'Approve'
57+
- 'Run the App'
58+
59+
steps:
60+
CloneRepo:
61+
type: git-clone
62+
repo: alex-codefresh/osx-demo-webserver
63+
git: github
64+
revision: master
65+
stage: 'Clone Repo'
66+
67+
TestParallel:
68+
type: parallel
69+
stage: 'Test & Build'
70+
steps:
71+
RunTests:
72+
type: 'freestyle-ssh'
73+
description: 'Run dummy unit tests..'
74+
working_directory: '${{CloneRepo}}/GCDWebServer'
75+
commands:
76+
- ./Run-Tests.sh
77+
fail_fast: false # ignore if the tests fail, just for the demo purposes
78+
BuildApp:
79+
type: 'freestyle-ssh'
80+
description: 'Build the application...'
81+
working_directory: '${{CloneRepo}}'
82+
83+
commands:
84+
- xcodebuild -workspace DemoWebServer.xcworkspace -scheme DemoWebServer archive -archivePath ../build/DemoWebServer.xcarchive | xcpretty
85+
86+
pending-approval:
87+
type: pending-approval
88+
description: 'Stop pipeline until approval. Just as an example'
89+
stage: 'Approve'
90+
fail_fast: true
91+
92+
RunApp:
93+
type: 'freestyle-ssh'
94+
description: 'Run the built sample web-server binary on the same node'
95+
working_directory: '${{CloneRepo}}'
96+
stage: 'Run the App'
97+
commands:
98+
- killall DemoWebServer 2>/dev/null || echo "No instances currently running, continuing" #just in case there is instance already running
99+
- bash -c "../build/DemoWebServer.xcarchive/Products/Applications/DemoWebServer.app/Contents/MacOS/DemoWebServer &"
100+
- sleep 60
101+
- kill $(jobs -p) 2>/dev/null || exit 0
102+
{% endraw %}
103+
{% endhighlight %}
104+
105+
This pipeline clones the sample application, builds it with Xcode and then runs it. Notice that the run step
106+
cleans up on its own (because macOS builds are not docker based so nothing is cleaned up automatically when the pipeline has finished).
107+
108+
Notice also that`freestyle-ssh` steps do not define a docker image (unlike normal[freestyle steps]({{site.baseurl}}/docs/pipelines/steps/freestyle/)).
109+
110+
The logs will show all build information:
111+
112+
{% include
113+
image.html
114+
lightbox="true"
115+
file="/images/incubation/osx-builds/osx-pipeline.png"
116+
url="/images/incubation/osx-builds/osx-pipeline.png"
117+
alt="macOS build log"
118+
caption="macOS build log"
119+
max-width="90%"
120+
%}
121+
122+
Currently, we are working on offering configurable versions of Xcode, Swift, and macOS so that pipelines can define exactly what development environment they need. We also plan[fastlane](https://fastlane.tools/){:target="\_blank"} integration.
123+

‎_docs/incubation/windows.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title:"Windows Containers Support Overview"
3+
description:"Using Docker on Windows in Codefresh"
4+
group:incubation
5+
redirect_from:
6+
-/docs/incubation/windows/
7+
-/docs/windows/
8+
-/docs/incubation/windows-beta/
9+
toc:true
10+
---
11+
12+
Codefresh pipelines have the option to support Windows based containers.
13+
14+
If you have projects in your organization based on the .NET Framework or are in transition from Windows to Linux based projects and still need to have CI/CD pipelines for Windows containers, you’ll now be able to achieve this by using Codefresh.
15+
16+
>Note: To enable Windows builds on your Codefresh account please[contact sales](https://codefresh.io/contact-us/){:target="\_blank"}
17+
18+
Once approved, you will get access to a new runtime environment on a dedicated Windows Server version 1709 VM. This means that you will be able to run both Windows and Linux/x86 builds from the same Codefresh account by choosing the appropriate[pipeline settings]({{site.baseurl}}/docs/pipelines/pipelines/#pipeline-settings).
19+
20+
21+
>Note: For .NET Core projects you can use a standard Linux based Codefresh account. See[our example]({{site.baseurl}}/docs/example-catalog/ci-examples/dotnet/).
22+
Codefresh Windows pipelines support the following Codefresh steps:
23+
**Clone**,**Build**,**Push**,**Composition**,**Deploy** and**Freestyle**.
24+
Please refer to our[steps documentation]({{site.baseurl}}/docs/pipelines/steps/) to learn more about each of them.
25+
26+
27+
##Example
28+
29+
In this example we'll perform the following steps:
30+
31+
- Clone our git repository and build a .NET Framework image.
32+
33+
- Run our dotnet unit tests and according to the results annotate the image accordingly.
34+
35+
- Push to Dockerhub if our tests have passed.
36+
37+
```yaml
38+
version:'1.0'
39+
steps:
40+
41+
BuildingDockerImage:
42+
title:Building Docker Image
43+
type:build
44+
image_name:codefresh/dotnetapp
45+
working_directory:./samples/dotnetapp
46+
tag:'{% raw %}${{CF_BRANCH_TAG_NORMALIZED}}{% endraw %}'
47+
dockerfile:Dockerfile
48+
49+
RunningUnitTests:
50+
title:Running Unit Tests
51+
image:'{% raw %}${{BuildingDockerImage}}{% endraw %}'
52+
command:dotnet test
53+
on_success:
54+
metadata:
55+
set:
56+
-'{% raw %}${{BuildingDockerImage.imageId}}{% endraw %}':
57+
-CF_QUALITY:true
58+
-repo_owner:'{% raw %}${{CF_REPO_OWNER}}{% endraw %}'
59+
-repo_name:'{% raw %}${{CF_REPO_NAME}}{% endraw %}'
60+
-branch_name:'{% raw %}${{CF_BRANCH}}{% endraw %}'
61+
-commit_author:'{% raw %}${{CF_COMMIT_AUTHOR}}{% endraw %}'
62+
-commit_url:'{% raw %}${{CF_COMMIT_URL}}{% endraw %}'
63+
-commit_message:'{% raw %}${{CF_COMMIT_MESSAGE}}{% endraw %}'
64+
on_fail:
65+
metadata:
66+
set:
67+
-'{% raw %}${{BuildingDockerImage.imageId}}{% endraw %}':
68+
-CF_QUALITY:false
69+
70+
PushingToDockerRegistry:
71+
title:Pushing to Docker Registry
72+
type:push
73+
candidate:'{% raw %}${{BuildingDockerImage}}{% endraw %}'
74+
tag:'{% raw %}${{CF_BRANCH_TAG_NORMALIZED}}{% endraw %}'
75+
registry:dockerhub
76+
77+
```
78+
79+
##Related articles
80+
[Introduction to pipelines]({{site.baseurl}}/docs/pipelines/introduction-to-codefresh-pipelines/)
81+
[Creating pipelines]({{site.baseurl}}/docs/pipelines/pipelines/)
82+
[Codefresh YAML]({{site.baseurl}}/docs/pipelines/what-is-the-codefresh-yaml/)
83+
[Installation options]({{site.baseurl}}/docs/installation/installation-options/)
37 KB
Loading
29.6 KB
Loading
41.1 KB
Loading
90.5 KB
Loading

‎images/incubation/osx-builds/.keep‎

Whitespace-only changes.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp