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.

Sign up for GitHub

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

Jump to bottom

feat: Add Introducing the Devfile AI Assistant blog post #55

Merged
merged 10 commits into from
Jun 21, 2024
Merged

feat: Add Introducing the Devfile AI Assistant blog post #55

Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2af5989
feat: Add Introducing the Devfile AI Assistant blog post
tolusha Jun 18, 2024
cf8fdfc
Fix typo
tolusha Jun 18, 2024
74960a1
Update _posts/2024-06-05-devfile-ai-assistant.adoc
tolusha Jun 19, 2024
344b5ae
Add What is devfile section
tolusha Jun 19, 2024
5801c3c
Fix typo
tolusha Jun 19, 2024
89fbe1c
Mention Walkthrough extention
tolusha Jun 19, 2024
58af3a2
Update _posts/2024-06-26-devfile-ai-assistant.adoc
tolusha Jun 21, 2024
af41a01
Update _posts/2024-06-26-devfile-ai-assistant.adoc
tolusha Jun 21, 2024
5ee00b7
Update _posts/2024-06-26-devfile-ai-assistant.adoc
tolusha Jun 21, 2024
a7f1f56
Fix typo
tolusha Jun 21, 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
322 changes: 322 additions & 0 deletions _posts/2024-06-05-devfile-ai-assistant.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,322 @@
---
tolusha marked this conversation as resolved.
Show resolved Hide resolved
title: Introducing the Devfile AI Assistant
layout: post
author: Anatolii Bazko
description: >-
The Devfile AI Assistant is an online tool that simplifies the creation of devfiles for developers.
categories: []
keywords: ['devfile', 'ChatGPT', 'AI']
slug: /@tolusha/devfile-ai-assistant
---

== Introducing the Devfile AI Assistant
tolusha marked this conversation as resolved.
Show resolved Hide resolved

In software development, it's important to be efficient. Whether you're an experienced developer or just starting, setting up your development environment can be complex and time-consuming. That's where the link:https://chatgpt.com/g/g-Bm20CP2Rp-devfile-assistant[Devfile AI Assistant] comes in. It's designed to help developers create devfiles easily without needing in-depth knowledge of the devfile syntax or structure. It uses a link:https://devfile.io[devfile knowledge base] to help you craft a devfile, making sure your development environment is set up right.

== Step-by-step example of how to create a devfile

Let's check out some real-life examples of how the Devfile AI Assistant can help you in creating devfiles for your projects."

. Start by providing a basic devfile.
+
**Request:**
+
[source]
----
Provide a basic devfile.
----
**Response:**
+
[source,yaml]
----
schemaVersion: 2.3.0
metadata:
name: basic-devfile
components:
- name: tools
container:
image: quay.io/devfile/universal-developer-image:latest
----

. Add a project to the devfile.
+
**Request:**
+
[source]
----
Add https://github.com/eclipse-che/che-server git project.
----
**Response:**
+
[source,yaml]
----
schemaVersion: 2.3.0
metadata:
name: basic-devfile
components:
- name: tools
container:
image: quay.io/devfile/universal-developer-image:latest
projects:
- name: che-server
git:
remotes:
origin: https://github.com/eclipse-che/che-server.git
----

. Add a new component to the devfile.
+
**Request:**
+
[source]
----
Add PostgreSQL component.
----
**Response:**
+
[source,yaml]
----
schemaVersion: 2.3.0
metadata:
name: devfile
components:
- name: tools
container:
image: quay.io/devfile/universal-developer-image:latest
- name: postgres
container:
image: postgres:latest
env:
- name: POSTGRES_DB
value: mydatabase
- name: POSTGRES_USER
value: user
- name: POSTGRES_PASSWORD
value: password
projects:
- name: che-server
git:
remotes:
origin: https://github.com/eclipse-che/che-server.git
----

. Add a volume to the devfile.
+
**Request:**
+
[source]
----
Add 2Gi volume in home user directory to store Maven artifacts.
----
**Response:**
+
[source,yaml]
----
schemaVersion: 2.3.0
metadata:
name: devfile
components:
- name: tools
container:
image: quay.io/devfile/universal-developer-image:latest
volumeMounts:
- name: maven-artifacts
path: /home/user/.m2
- name: postgres
container:
image: postgres:latest
env:
- name: POSTGRES_DB
value: mydatabase
- name: POSTGRES_USER
value: user
- name: POSTGRES_PASSWORD
value: password
- name: maven-artifacts
volume:
size: 2Gi
projects:
- name: che-server
git:
remotes:
origin: https://github.com/eclipse-che/che-server.git
----

. Add command to the devfile.
+
**Request:**
+
[source]
----
Add command to build a java project.
----
**Response:**
+
[source,yaml]
----
schemaVersion: 2.3.0
metadata:
name: devfile
components:
- name: tools
container:
image: quay.io/devfile/universal-developer-image:latest
volumeMounts:
- name: maven-artifacts
path: /home/user/.m2
- name: postgres
container:
image: postgres:latest
env:
- name: POSTGRES_DB
value: mydatabase
- name: POSTGRES_USER
value: user
- name: POSTGRES_PASSWORD
value: password
- name: maven-artifacts
volume:
size: 2Gi
projects:
- name: che-server
git:
remotes:
origin: https://github.com/eclipse-che/che-server.git
commands:
- id: build-java-project
exec:
commandLine: mvn clean install
component: tools
group:
kind: build
isDefault: true
label: Build Java Project
workingDir: /projects/che-server
----

. Add resource limits to the devfile.
+
**Request:**
+
[source]
----
Add resource limits to all components.
----
**Response:**
+
[source,yaml]
----
schemaVersion: 2.3.0
metadata:
name: devfile
components:
- name: tools
container:
image: quay.io/devfile/universal-developer-image:latest
volumeMounts:
- name: maven-artifacts
path: /home/user/.m2
cpuLimit: 2
memoryLimit: 4Gi
- name: postgres
container:
image: postgres:latest
env:
- name: POSTGRES_DB
value: mydatabase
- name: POSTGRES_USER
value: user
- name: POSTGRES_PASSWORD
value: password
cpuLimit: 1
memoryLimit: 2Gi
- name: maven-artifacts
volume:
size: 2Gi
projects:
- name: che-server
git:
remotes:
origin: https://github.com/eclipse-che/che-server.git
commands:
- id: build-java-project
exec:
commandLine: mvn clean install
component: tools
group:
kind: build
isDefault: true
label: Build Java Project
workingDir: /projects/che-server
----

. Add metadata to the devfile.
+
**Request:**
+
[source]
----
Add metadata based on the devfile.
----
**Response:**
+
[source,yaml]
----
schemaVersion: 2.3.0
metadata:
name: devfile
displayName: Java with PostgreSQL Dev Environment
description: A development environment for a Java project with PostgreSQL database support.
language: Java
projectType: Java Application
version: 1.0.0
provider: Eclipse Che
tags:
- java
- postgres
- maven
- database
components:
- name: tools
container:
image: quay.io/devfile/universal-developer-image:latest
volumeMounts:
- name: maven-artifacts
path: /home/user/.m2
cpuLimit: 2
memoryLimit: 4Gi
- name: postgres
container:
image: postgres:latest
env:
- name: POSTGRES_DB
value: mydatabase
- name: POSTGRES_USER
value: user
- name: POSTGRES_PASSWORD
value: password
cpuLimit: 1
memoryLimit: 2Gi
- name: maven-artifacts
volume:
size: 2Gi
projects:
- name: che-server
git:
remotes:
origin: https://github.com/eclipse-che/che-server.git
commands:
- id: build-java-project
exec:
commandLine: mvn clean install
component: tools
group:
kind: build
isDefault: true
label: Build Java Project
workingDir: /projects/che-server
----

== Conclusion

Are you a developer looking to simplify setting up your development environment? The Devfile AI Assistant is here to help! It provides clear and accurate configurations, taking the complexity out of the process. Give the Devfile AI Assistant a try today!
Loading