Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lechnerc77/create-funcdocker-cli
A (unofficial) CLI for Azure Functions Containers
https://github.com/lechnerc77/create-funcdocker-cli
azure-functions docker dockerfile kubernetes
Last synced: 19 days ago
JSON representation
A (unofficial) CLI for Azure Functions Containers
- Host: GitHub
- URL: https://github.com/lechnerc77/create-funcdocker-cli
- Owner: lechnerc77
- License: agpl-3.0
- Created: 2021-12-23T13:14:41.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-08T14:59:37.000Z (about 3 years ago)
- Last Synced: 2024-11-13T15:57:36.744Z (3 months ago)
- Topics: azure-functions, docker, dockerfile, kubernetes
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@lechnerc77/create-funcdocker-cli
- Size: 53.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
README
# A (unofficial) CLI for Azure Functions Containers
## What
This CLI supports you in scaffolding the files necessary to create Azure Functions in containers. The CLI enables you to create the following files:
- `Dockerfile`
- `.dockerignore`
- `Makefile` (optional)
- `deployment.yaml` for Kubernetes deployments (optional)
including several options that control the behavior of the containerized Azure Functions.
## Why
The [Azure Function Core Tools](https://github.com/Azure/azure-functions-core-tools) comprise a CLI that also creates some [basic versions](https://github.com/Azure/azure-functions-core-tools#getting-started-on-kubernetes) of the `Dockerfile` and `.dockerignore`. However, the templates are static and only reflect your runtime e.g. nodeJS. This serves as a starting point, but in most cases manual adoptions need to be made.
This CLI shall close this gap and make the experience more convenient by offering more options for the creation process.
## Installation
Install the latest version via
```shell
npm install -g @lechnerc77/create-funcdocker-cli
```
## Usage
The easiest way to start the CLI is to start the command.
```shell
create-funcdocker
```
This will guide you through some questions and based on your answers create the files needed to containerize your Azure Functions.
>> Attention: When executing the CLI, you do not need to be in an Azure Functions Project. You can create the files also independent of a project.
You can also feed-in the parameters directly into the CLI. The following parameters are available:
```shell
--help | -h: Help for create-funcdocker CLI
--version | -v: Version of create-funcdocker CLI
--manually | -m: Suppress collection of configuration from Azure Functions project
--dryrun | -d: Execute the generation in dry run, no files are written
--language | --la: Language used for the Azure Functions
--lversion | --lv: Version of the language e.g. 16 for nodeJS
--funccoreversion | --fv: Version of the Azure Function Runtime (3 or 4)
--dockerbaseimage | --di: Name of the Docker base image that shall be used
--disablefunchomepage | --dh: Disable the Azure Functions homepage
--defaultport | --dp: Override the exposed default port of your Azure Function
--addmakefile | --am: Add a Makefile
--dockerid | --id: ID of your Docker account
--appname | --an: Name of your application
--appversion | --av: Version of your application
--kubernetes | --k: Create a Kubernetes deplyoment file
```
If you provide some parameters, the remaining ones will then be fetched by the CLI in an interactive mode.
>> Attention: The CLI will overwrite existing files.
### Execution in an Azure Functions project
If you start the CLI in a directory that contains an Azure Functions project the CLI will do its best to collect the information from the project settings. You can switch this off by setting the flag ` --manually | -m`. The parameter must be set when calling the CLI, you will not be asked in the interactive mode.
### Dry Run
You can also execute the CLI in dry run mode by setting the flag `--dryrun | -d`. This means that the CLI will execute all steps as in a regular execution, but the files will not be written to your file system. Instead you the CLI will show the file content in the console. The parameter must be set when calling the CLI, you will not be asked in the interactive mode.
### Kubernetes
The flag `--kuberntes | --k` creates a sample deployment file for your containerized Azure Function. It will be created in a folder `k8s` and consists of a deployment and a service (type `ClusterIP`). If the folder does not exist it will be created.
## Development and Contributions
Contributions to the CLI are highly welcome. If you want to start developing you need to execute the following steps:
1. Clone this repository
2. Navigate into the directory of the cloned repository and install the dependencies via:
```shell
npm install
```
3. For a convenient local execution execute
```shell
npm link
```
You can now call the CLI via:
```shell
create-funcdocker
```