You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-2Lines changed: 23 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@ Currently supported cloud flavours are:
16
16
*[Tanzu](https://github.com/dodevops/cloudcontrol/pkgs/container/cloudcontrol-tanzu) (based on [alpine](https://hub.docker.com/_/alpine)) [linux/amd64]
17
17
18
18
Following features and tools are supported:
19
+
* ⚙️ Direnv
19
20
* 🐟 Fish Shell
20
21
* 📷 AzCopy
21
22
* 🪪 Certificates
@@ -51,6 +52,7 @@ Following features and tools are supported:
51
52
*[simple](#simple)
52
53
*[tanzu](#tanzu)
53
54
*[Features](#features)
55
+
*[Direnv](#.template)
54
56
*[Fish Shell](#_fish)
55
57
*[AzCopy](#azcopy)
56
58
*[Certificates](#certificates)
@@ -359,6 +361,15 @@ The kubernetes login tokens usually expire after a few hours already. You can ru
359
361
does.
360
362
361
363
## Features
364
+
### <aid=".template"></a> Direnv
365
+
366
+
Installs [Direnv](https://direnv.net/)
367
+
368
+
#### Configuration
369
+
370
+
* USE_.template: Enable this feature
371
+
* DEBUG_.template: Debug this feature
372
+
362
373
### <aid="_fish"></a> Fish Shell
363
374
364
375
Installs and configures the [Fish Shell](https://fishshell.com/) with configured [Spacefish theme](https://spacefish.matchai.me/)
@@ -643,14 +654,24 @@ Installs the [YAML parser and processor yq](https://github.com/mikefarah/yq)
643
654
644
655
## Development
645
656
646
-
*CloudControl* supports a decoupled development of features and flavours. If you're missing something, just fork this
647
-
repository, create a subfolder for your new feature under "features" and add these files:
657
+
*CloudControl* supports a decoupled development of features and flavours.
658
+
659
+
### Features
660
+
661
+
If you're missing a feature, just fork this repository, copy the feature template from features/.template into a
662
+
new subfolder, check out the comments in the example files, and modify them to your needs.
663
+
664
+
These files make up a feature:
648
665
649
666
*`feature.yaml`: A descriptor for your feature with a title, a description and configuration notes
650
667
*`install.sh`: A shell script that is run by CloudControlCenter and should install everything you need
651
668
for your new feature
652
669
*`motd.sh`: (optional) If you want to show some information to the users upon login, put them here.
653
670
671
+
And an optional, but recommended `.goss` folder for [integration testing](#integration-testing).
672
+
673
+
### Flavours
674
+
654
675
If you need another flavour (aka cloud provider), add a new subdirectory under "flavour" and add a flavour.yaml describing
655
676
your flavour the same way as a feature. For the rest of the files, please check out existing flavours for details. Please,
656
677
include a sample configuration for your flavour to make it easier for other people to work with it.
0 commit comments