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

Modify starting template to reflect new standard for image name #428

Closed
wants to merge 1 commit into from
Closed
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: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Anyone who builds many Argo workflows knows that after a while you end up reusin
* [Ask for a new Workflow](#Ask-for-a-new-Workflow)

## Main Features
* [Extensive UI for visualization and navigation](#Extensive-ui-for-visualization-and-navigation)
* [Extensive UI for visualization and navigation](#Extensive-ui-for-visualization-and-navigation)
* [WorkflowTemplate and inner template breakdown](#WorkflowTemplate-and-inner-template-breakdown)
* [WorkflowTemplate manifest conventions](#WorkflowTemplate-manifest-conventions)
* [Hub file system Structure](#Hub-file-system-Structure)
Expand All @@ -41,6 +41,7 @@ To build an extensive UI while still using use of the original Kubernetes manife

#### WorkflowTemplate annotations
* `argo-hub/version` - sem version (0.0.2)
* `argo-hub/name` - name of the template
* `argo-hub/description` - description to be shown
* `argo-hub/license` - license (MIT)
* `argo-hub/owner_name` - github user name to appear in the site
Expand All @@ -54,7 +55,7 @@ To build an extensive UI while still using use of the original Kubernetes manife
#### Inner template annotations
* `argo-hub-template/description` - description for specific template
* `argo-hub-template/icon_url` - icon for specific template
* `argo-hub-template/icon_background` - background for icon
* `argo-hub-template/icon_background` - background for icon


### Hub file system Structure
Expand All @@ -71,7 +72,7 @@ Every workflowTemplate folder has the following structure and files: <br>
Every version folder has the following structure and files: <br>
* `workflowTemplate.yaml` - the main manifest that follows the [conventions](#WorkflowTemplate-manifest-conventions)
* `rbac.yaml` - a single file with 3 required manifests that provides the permissions for workflow template
* `images` folder - each sub-folder results in a docker build according to the inner Dockerfile, and is automatically built scanned and pushed to argo-hub registry: `quay.io/codefreshplugins/argo-hub-workflows-{NAME}-versions-${VERSION}-${IMAGE_FOLDER_NAME}:main`
* `images` folder - each sub-folder results in a docker build according to the inner Dockerfile, and is automatically built scanned and pushed to argo-hub registry: `quay.io/codefreshplugins/argo-hub-{NAME}-${IMAGE_FOLDER_NAME}:${VERSION}-main`
* `docs` folder - contains documentation for every template within the workflowTemplate (name be identical to the template name)

### Versioning
Expand All @@ -83,7 +84,7 @@ A full release life cycle has been built to do the following:
* validate that the changes adhere to the conventions (coming soon, for now manually by reviewer)
* build all images defined in the `image` folder (#Automatic-image-building-and-security-scanning)
* scan the built images
* push the images into public quay registry
* push the images into public quay registry

### Automatic image building and security scanning
Workflow tasks often involve complex scripts with dependencies that have to be installed manually, wasting valuable execution time and complexing the workflow. <br>
Expand All @@ -99,7 +100,7 @@ Eventually Argo Hub is simple, being a set of reusable Kubernetes manifests (wor
There are different ways to be able to consume the workflowTemplates:

* Applying a workflow template directly to your Kubernetes cluster
just use `kubectl apply -f {file}` and apply a specific filer or folder
just use `kubectl apply -f {file}` and apply a specific filer or folder

* Using Argo CD you can easily get the entire argo hub by getting it automatically applied to your cluster using the GitOps approach. <br>

Expand Down Expand Up @@ -140,7 +141,3 @@ First thing to do is to fork the repository.
## Ask for a new Workflow

Please fill a github issue or thumb up an existing one




8 changes: 5 additions & 3 deletions utils/starting-template/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Changelog

## v0.0.1 (?)
## v0.0.2( INSERT DATE HERE)

### task
Added something awesome

short description
## v0.0.1 ( INSERT DATE HERE)

Initial version
6 changes: 4 additions & 2 deletions utils/starting-template/versions/0.0.1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@

## Summary

description
**Note:** Insert the description of your workflowTemplate

## Templates

1. [task](https://github.com/codefresh-io/argo-hub/blob/main/workflows/starting-template/versions/0.0.1/docs/task.md)
**Note:** Add all the templates (aka methods that can be called in your plugin). The name of the template aka `task` will match a file named *TEMPLATE.md* under the docs folder aka `task.md`

1. [task](https://github.com/codefresh-io/argo-hub/blob/main/workflows/starting-template/versions/0.0.1/docs/task.md)

## Security

Expand Down
13 changes: 8 additions & 5 deletions utils/starting-template/versions/0.0.1/workflowTemplate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@ kind: WorkflowTemplate
metadata:
name: argo-hub.starting-template.0.0.1
annotations:
argo-hub/name: 'Starting Template'
argo-hub/version: '0.0.1'
argo-hub/description: 'Starting template'
argo-hub/categories: 'argo'
argo-hub/license: 'MIT'
argo-hub/owner_name: 'Itai Gendler'
argo-hub/owner_email: '[email protected]'
argo-hub/owner_avatar: 'https://avatars.githubusercontent.com/u/10414627?s=120&v=4'
argo-hub/owner_url: 'https://github.com/itai-codefresh'
argo-hub/owner_name: 'Your Name'
argo-hub/owner_email: '[email protected]'
argo-hub/owner_avatar: 'https://github.com/USER_ID.png'
argo-hub/owner_url: 'https://github.com/USER_ID'
argo-hub/icon_url: "https://cdn.jsdelivr.net/gh/codefresh-io/argo-hub@main/workflows/starting-template/assets/icon.svg"
argo-hub/icon_background: "#81D4FA"
spec:
Expand All @@ -28,6 +29,8 @@ spec:
container:
name: main
imagePullPolicy: Always
image: alpine
# format of the image created by the Full Release Cycle [https://github.com/codefresh-io/argo-hub#Full-release-life-cycle]
# quay.io/codefreshplugins/argo-hub/{TEMPLATE_FOLDER_NAME}-{IMAGE_FOLDER}:{VERSION}-main
image: quay.io/codefreshplugins/argo-hub-starting-template-task:0.0.1-main
command:
- echo {{ inputs.parameters.TEXT }}