template-go

Template Go

Template repo for extensions integrating with arhat via arhat-proto using arhat.dev/libext in Go

Usage

1. Create a new repo using this template
2. Rename template-go (most importantly, the module name in go.mod file) according to your preference
3. Update application configuration definition in pkg/conf
4. Update extension name my-extension-name in pkg/cmd
5. Implement your extension by updating code in pkg/<some name>
   • e.g. peripheral extension: in pkg/peripheral
6. Update deployment charts in cicd/deploy/charts/
7. Document supported features docs
   • e.g. peripheral extension: in docs/peripheral.md
8. Deploy to somewhere it can communicate with arhat (host or container)

LICENSE

Copyright 2020 The arhat.dev Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.