The build system requires git source code management. If the directory you choose to generate your service is not under git control, do the following after executing your template. git init vi .gitignore # add .templates/* # save your .gitignore git add * git commit
The make file sets three versioning variables; VERSION, BUILD, and GIT_TAG. These are passed go the go compiler and printed when the -v flag is passed on the command line. Output is formated as JSON.
films -v
{"Version": "1.0.0", "Build": "8755e7f", "GitTag": "v0.0alpha"}
The version variable is set based on the value you enter in your defintions file
The build is set to the commit id of your current HEAD
GIT_TAG set using the most recent tag if any. You can add a tag with: git tag -a "mytag" -m "message about the tag." Git push doesn't include tags. To push tags to the origin use: git push origin --tag
The roadctl is modeled after kubectl. Use roadctl help for a list of top level commands. This may be different for a specific commnad or it's sub-commands.
roadctl help roadctl allows you to work with the PavedRoad CNCF low-code environment and the associated CI/CD pipeline
Usage: roadctl [command] [TYPE] [NAME] [flags]
TYPE specifies a resource type NAME is the name of a resource flags specify options
Usage:
roadctl [command]
Available Commands:
apply Apply configuration to named resource
config manage roadctl global configuration options
create create a new resource
delete delete a resource
deploy deploy a service
describe describe provides detailed information about a resource
doc Generate documentation for your service
edit edit the configuration for the specified resource
events View events
explain return documentation about a resource
get get an existing object
help Help about any command
logs return logs for a resource
replace Delete and recreate the named resource
version Print the current version
Flags:
--config string Config file (default is $HOME/.roadctl.yaml)
--debug string Debug level: info(default)|warm|error|critical (default "d")
--format string Output format: text(default)|json|yaml (default "f")
-h, --help help for roadctl
Use "roadctl [command] --help" for more information about a command.
roadctl get --help Return summary information about an existing resource
Usage: roadctl get [flags]
Flags: -h, --help help for get -i, --init Initialize template repository -r, --repo string Change default repository for templates (default "https://github.pavedroad-io/templates")
Global Flags: --config string Config file (default is $HOME/.roadctl.yaml) --debug string Debug level: info(default)|warm|error|critical (default "d") --format string Output format: text(default)|json|yaml (default "f")
The roadctl CLI is used to create new services. It has two fundamental concepts:
- templates: Contain logic need to generate a service
- definitions: Define your custom logic, integrations, and oragnizational information
A sample definitions is available to help you get started
roadctl get templates --init
roadctl get templates
roadctl describe templates datamgr > myservice.yaml
roadctl explain templates datamgr > myservice.yaml
roadctl create templates --template datamgr --definition myservice.yaml
Executing make will compilte and test your service. Optionally, you
can do make compile followed by make check
make
| Name | Contents |
|---|---|
| artifacts | Outputs from static code analysis and tests |
| assets | Generate assets such as images |
| builds | Executables for supported platforms, Mac/Linux x86/amd64 |
| dev | Generated helper scripts and sample data |
| dev/db | Generated SQL statments |
| docs | Generated documentation |
| logs | Logs generated by the microservice |
| manifests | Docker and docker-composes manifest |
| mainfests/kubernetes | Kubernetes manifests for deploying this microservice |
| vendor | Vendor dependencies |
To get an SQL prompt, use: bin/sql.sh
The following scripts work with your local docker images using docker-compose or with the local microk8s cluster. By default they use the local docker image. To use the microk8s cluster, use the -k command line option/flag.
- dev/testAll.sh
- dev/testPost.sh
- dev/testPut.sh
- dev/testGet.sh
- dev/testGetList.sh
Use make help to get a list of options make help
Choose a command run in films:
compile Compile the binary.
clean Remove dep, vendor, binary(s), and executs go clean
build Build the binary for linux / mac x86 and amd
deploy Deploy image to repository and k8s cluster
install Install packages or main
check Start services and execute static code analysis and tests
show-coverage Show go code coverage in browser
show-test Show sonarcloud test report
show-devkit Show documenation for Devkit
fmt Run gofmt on all code
simplify Run gofmt with simplify option
k8s-start Start local microk8s server and update configurations
k8s-stop Stop local k8s cluster and delete skaffold deployments
k8s-status Print the status of the local cluster up or down
help Print possible commands
Skaffold is integrated into your project. You can use the following commands:
Monitors source code and when it changes builds and pushs a new image
skaffold dev -f manifests/skaffold.yamlBuilds and push image once when executed
skaffold run -f manifests/skaffold.yamlDeletes all deployed resources
skaffold delete -f manifests/skaffold.yamlThree lint applications are integrated to assist in code reviews.
- Go lint checks for conformance with effective go programming recommendations and Go code review suggestions.
- Gosec tests your code against go recommended security practices
- Govet inspects code for constructs that might break.
The location of each lint's output is below along with links to the rules they enforce.
artifacts/lint.out Effective Go Go code review comments
artifacts/gosec.out Rules
artifacts/govet.out Go vet rules