redhat-cop / dash Goto Github PK

License: Apache License 2.0

Go 89.27% Makefile 10.73%

dash's Introduction

Dash Prototype

Dash is an automation framework for Kubernetes. The aim is to combine the power of Kubernetes declarative management and popular templating engines to provide a full-featured automation strategy for Kubernetes cluster and application management.

Dash helps to enable GitOps and Infrastructure as Code workflows in enterprises with complex use cases.

Features

Template Support

Currently Dash supports the following templates:

FileTemplates - not really templates, just static resource definitions
HelmCharts
OpenShift Templates

Installation

Those with a go environment can install simply by running

go get github.com/redhat-cop/dash

If you want a stable release, we recommend downloading the appropriate binary from our releases page.

Quickstart

To run, first log into your kubernetes cluster, and:

dash -i examples/default/

Contribute

We would love for you to contribut to this project! For more information on how to get started, see our dev guide.

dash's People

Contributors

Stargazers

Watchers

Forkers

tylerauerbeck huddlesj darthlukan oybed sabre1041 jacobsee etsauer pabrahamsson

dash's Issues

Ability to process content that is behind a private endpoint (URL,repo,etc.)

Not sure what exactly we mean by this or how to handle it.

Solution for freeform variable substitution in an inventory

support variable hierarchy, such that variables can be set at multiple levels, overriding as they get more specific.

support pre/post hooks to for example “post-process” aspects like service/application configuration and “pre-process” waiting for resources to be available

Implement a default inventory for simple use cases.

In order to lower the barrier, Dash should be able to run against an embedded default inventory such that simple repositories with a predictable directory structure could run without its own inventory file.
(see below for proposed default values)

verison: 3.0
resource_groups:
  - name: Default Resources
    resources:
    - name: Raw Manifests
      file: manifests/
    - name: Helm Templates
      template: helm/
      type: helm
    - name: OpenShift Templates
      template: openshift-templates/
      params: openshift-template-params/

Need a way to process OpenShift Templates

Introduce helper functions like`init,add` to help users manage their dash repos

@jacobsee I was thinking we could look at folding the applier-cli functionality in here.

Ability to fetch data from resources in the cluster to be used later (action: get)

Support for freeform templating, like jinja or go templates

support dynamically combining multiple “inventory” definitions to compose a bigger collection of objects making it possible to re-use the same definitions more easily to avoid duplicates

@redhat-cop/openshift-applier

Develop a more thorough quickstart for the README

We need a better basic walkthrough of using dash, and building up your first dash inventory.

Support kustomize as a template type

Resources get reconciled multiple times.

Because of the way that we set up and manage the tmp directory, the resources generated are being reconciled multiple times. We need to move the management and cleanup of the tmpDir into the ResourceGroup processing, so that for each ResourceGroup, we create and destroy a tmpDir.

Preview what's about to be applied
Integrate with other tooling in the kube space (for example ArgoCD custom plugin)

Utilize CLI Processing Library

Make use of a CLI library to parse input arguments.

Recommend a tool such as Corba as it is the defacto tools in many Kubernetes based projects

nginx example fails to start on deployment

Tested the Dash example. Below is the output:

[root@a1 dash-proto]# go version
go version go1.12.10 linux/amd64
[root@a1 dash-proto]# oc new-project dash-test
Now using project "dash-test" on server "https://api.test.jk308.com:6443".

You can add applications to this project with the 'new-app' command. For example, try:

    oc new-app django-psql-example

to build a new example application in Python. Or use kubectl to deploy a simple Kubernetes application:

    kubectl create deployment hello-node --image=gcr.io/hello-minikube-zero-install/hello-node

[root@a1 dash-proto]# oc project
Using project "dash-test" on server "https://api.test.jk308.com:6443".
[root@a1 dash-proto]# go run cmd/dash.go -i examples/default/
2019/10/19 12:39:28 Resource: Raw Manifests, Namespace: 
2019/10/19 12:39:28 Source: /root/git/dash-proto/examples/default/manifests, Dest: /tmp/dash142426629
2019/10/19 12:39:28 Resource: Helm Charts, Namespace: 
2019/10/19 12:39:28 Resource: OpenShift Templates, Namespace: 
Running command: [kubectl apply -f /tmp/dash142426629]
deployment.apps/nginx-deployment created

[root@a1 dash-proto]# oc get pods
NAME                               READY   STATUS              RESTARTS   AGE
nginx-deployment-6dd86d77d-58z2m   0/1     ContainerCreating   0          8s
[root@a1 dash-proto]# oc get pods
NAME                               READY   STATUS              RESTARTS   AGE
nginx-deployment-6dd86d77d-58z2m   0/1     ContainerCreating   0          29s
[root@a1 dash-proto]# oc get pods
NAME                               READY   STATUS             RESTARTS   AGE
nginx-deployment-6dd86d77d-58z2m   0/1     CrashLoopBackOff   7          14m
[root@a1 dash-proto]# oc log nginx-deployment-6dd86d77d-58z2m
log is DEPRECATED and will be removed in a future version. Use logs instead.
2019/10/19 17:52:40 [warn] 1#0: the "user" directive makes sense only if the master process runs with super-user privileges, ignored in /etc/nginx/nginx.conf:2
nginx: [warn] the "user" directive makes sense only if the master process runs with super-user privileges, ignored in /etc/nginx/nginx.conf:2
2019/10/19 17:52:40 [emerg] 1#0: mkdir() "/var/cache/nginx/client_temp" failed (13: Permission denied)
nginx: [emerg] mkdir() "/var/cache/nginx/client_temp" failed (13: Permission denied)
[root@a1 dash-proto]#