github.com/oam-dev/kubevela@v1.9.11/pkg/definition/gen_sdk/_scaffold/go/README.md (about)

     1  # KubeVela Go SDK
     2  
     3  This is a Go SDK for KubeVela generated via vela CLI
     4  
     5  ## Installation
     6  
     7  Recommended way to install this SDK is run command below.
     8  
     9  ```shell
    10  go get github.com/kubevela-contrib/kubevela-go-sdk
    11  go mod edit -replace=sigs.k8s.io/apiserver-network-proxy/konnectivity-client=sigs.k8s.io/apiserver-network-proxy/konnectivity-client@v0.0.24
    12  ```
    13  
    14  ## Features:
    15  
    16  - 🔧Application manipulating
    17    - [x] Add Components/Traits/Workflow Steps/Policies
    18    - [x] Set Workflow Mode
    19    - [x] Convert to/from K8s Application Object
    20    - [x] Convert to YAML/JSON
    21    - [x] Get Components/Traits/Workflow Steps/Policies from app
    22    - [x] Validate Application required parameters recursively
    23    - [ ] Referring to external Workflow object.
    24  - 🔍Application client
    25    - [x] Create/Delete/Patch/Update Application
    26    - [x] List/Get Application
    27  
    28  ## Example
    29  
    30  See [example](example) for some basic usage of this SDK.
    31  
    32  ## Future Work
    33  
    34  There is some proper features for this SDK and possible to be added in the future. If you are interested in any of them, please feel free to contact us.
    35  
    36  - Part of vela CLI functions
    37    - Application logs/exec/port-forward
    38    - Application resource in tree structure
    39    - VelaQL
    40    - ...
    41  - Standalone workflow functions
    42    - CRUD of workflow
    43  
    44  ## Known issues
    45  
    46  There are some known issues in this SDK, please be aware of them before using it.
    47  
    48  1. `labels` and `annotations` trait is not working as expected.
    49  2. `notification` workflow-step's parameter is not exactly the same as the one in KubeVela.