Go Package Documentation Collection

https://pkg.go.dev/doc/
Admin
A comprehensive collection of Go package documentation from pkg.go.dev converted to markdown format...
Tokens:324,931
Snippets:4,184
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Basic Echo Server Setup

Source: https://pkg.go.dev/docker.baopinshidai.com/labstack/echo

This example demonstrates the basic setup of an Echo web server, including middleware configuration and route definition. It starts an HTTP server on port 1323.

```go
package main

import (
	"net/http"

	"github.com/labstack/echo"
	"github.com/labstack/echo/middleware"
)

func main() {
	// Echo instance
	e := echo.New()

	// Middleware
	e.Use(middleware.Logger())
	e.Use(middleware.Recover())

	// Routes
	e.GET("/", hello)

	// Start server
	e.Logger.Fatal(e.Start(":1323"))
}

// Handler
func hello(c echo.Context) error {
	return c.String(http.StatusOK, "Hello, World!")
}

```

--------------------------------

### LocalInstaller Install Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Installs a plugin from the local filesystem. Implements the Installer interface.

```go
func (i *LocalInstaller) Install() error
```

--------------------------------

### Install prometheus-kafka-consumer-group-exporter

Source: https://pkg.go.dev/docker-proxy.hotik.asia/kawamuray/prometheus-kafka-consumer-group-exporter

Installs the exporter using go get and shows how to access the help command.

```bash
$ go get github.com/kawamuray/prometheus-kafka-consumer-group-exporter/...
$ $GOPATH/bin/prometheus-kafka-consumer-group-exporter -help
```

--------------------------------

### Install Gorm Adapter

Source: https://pkg.go.dev/docker-proxy.hotik.asia/casbin/gorm-adapter

Use 'go get' to install the gorm-adapter package.

```go
go get github.com/casbin/gorm-adapter

```

--------------------------------

### Start Kubernetes Cluster with Minikube

Source: https://pkg.go.dev/docker-proxy.hotik.asia/ceph/ceph-csi/e2e

Use this script to start a local Kubernetes cluster and prepare a disk for Rook. Ensure minikube is installed and configured.

```bash
./minikube.sh up
```

--------------------------------

### Installation

Source: https://pkg.go.dev/docker-proxy.hotik.asia/casbin/gorm-adapter

Install the gorm-adapter package using go get.

```APIDOC
go get github.com/casbin/gorm-adapter
```

--------------------------------

### Start Custom HTTP Server

Source: https://pkg.go.dev/docker.baopinshidai.com/labstack/echo

Starts a custom http.Server instance.

```go
func (e *Echo) StartServer(s *http.Server) (err error)
```

--------------------------------

### Install go-git

Source: https://pkg.go.dev/docker.baopinshidai.com/src-d/go-git

Use 'go get' to install the go-git library. This command ensures you have the latest version.

```bash
go get -u gopkg.in/src-d/go-git.v3/...
```

--------------------------------

### VCSInstaller Install Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Installs a plugin from a VCS repository. Implements the Installer interface.

```go
func (i *VCSInstaller) Install() error
```

--------------------------------

### Install and Run

Source: https://pkg.go.dev/docker-proxy.hotik.asia/kawamuray/prometheus-kafka-consumer-group-exporter

Instructions on how to install and run the prometheus-kafka-consumer-group-exporter.

```APIDOC
## Install and run
```
$ go get github.com/kawamuray/prometheus-kafka-consumer-group-exporter/...
$ $GOPATH/bin/prometheus-kafka-consumer-group-exporter -help
```
```

--------------------------------

### Start HTTPS Server with Files

Source: https://pkg.go.dev/docker.baopinshidai.com/labstack/echo

Starts an HTTPS server using provided certificate and key files.

```go
func (e *Echo) StartTLS(address string, certFile, keyFile string) (err error)
```

--------------------------------

### Helm Client InstallRelease Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm

Installs a chart from a string and returns the installation response.

```go
func (h *Client) InstallRelease(chstr, ns string, opts ...InstallOption) (*rls.InstallReleaseResponse, error)
```

--------------------------------

### Helm Client InstallReleaseWithContext Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm

Installs a chart from a string with context support and returns the installation response.

```go
func (h *Client) InstallReleaseWithContext(ctx context.Context, chstr, ns string, opts ...InstallOption) (*rls.InstallReleaseResponse, error)
```

--------------------------------

### Start Metrics Server

Source: https://pkg.go.dev/docker-proxy.hotik.asia/ceph/ceph-csi/pkg/util

Starts an HTTP server for metrics collection. Requires a configuration object.

```go
func StartMetricsServer(c *Config)
```

--------------------------------

### Install Temple using Go

Source: https://pkg.go.dev/docwhat.org/temple

Build the Temple binary from source if you have Go v1.6 or later installed.

```bash
go install docwhat.org/temple

```

--------------------------------

### LocalInstaller Install

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Installs a plugin from the filesystem to $HELM_HOME.

```APIDOC
## (*LocalInstaller) Install

### Description
Installs a plugin from the filesystem.

### Method Signature
```
func (i *LocalInstaller) Install() error
```

### Returns
* **error** - An error if the installation fails.
```

--------------------------------

### Helm Client InstallReleaseFromChart Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm

Installs a chart object and returns the installation response.

```go
func (h *Client) InstallReleaseFromChart(chart *chart.Chart, ns string, opts ...InstallOption) (*rls.InstallReleaseResponse, error)
```

--------------------------------

### Install http2curl package

Source: https://pkg.go.dev/moul.io/http2curl

Install the http2curl package using the go get command.

```bash
$ go get github.com/moul/http2curl

```

--------------------------------

### Start HTTP Server

Source: https://pkg.go.dev/docker.baopinshidai.com/labstack/echo

Starts an HTTP server on the specified address.

```go
func (e *Echo) Start(address string) error
```

--------------------------------

### HTTPInstaller Install Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Downloads and extracts a plugin tarball, then creates a symlink in $HELM_HOME. Implements the Installer interface.

```go
func (i *HTTPInstaller) Install() error
```

--------------------------------

### Start Local Repository Function

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/repo

Starts a web server to serve files from a specified local directory.

```go
func StartLocalRepo(path, address string) error
```

--------------------------------

### Get dbxcli using go get

Source: https://pkg.go.dev/docker.fstream.us.kg/dropbox/dbxcli

Installs the dbxcli package using the Go build tool. This command fetches the source code and makes it available for building.

```bash
go get github.com/dropbox/dbxcli

```

--------------------------------

### Helm Client InstallReleaseFromChartWithContext Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm

Installs a chart object with context support and returns the installation response.

```go
func (h *Client) InstallReleaseFromChartWithContext(ctx context.Context, chart *chart.Chart, ns string, opts ...InstallOption) (*rls.InstallReleaseResponse, error)
```

--------------------------------

### NewForSource Function

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Creates a new Installer based on the source string and version. Selects the correct installer type.

```go
func NewForSource(source, version string, home helmpath.Home) (Installer, error)
```

--------------------------------

### Install Function

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Installs a Helm plugin to the $HELM_HOME directory. Requires an Installer implementation.

```go
func Install(i Installer) error
```

--------------------------------

### Install Options

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm

Options available for the Helm install operation.

```APIDOC
## Install Options

### Description
These options customize the behavior of the Helm install command.

### Available Options
- **InstallDescription(description string)**: Sets a description for the release.
- **InstallDisableCRDHook(disable bool)**: Disables the CRD hook during installation.
- **InstallDisableHooks(disable bool)**: Disables all hooks during installation.
- **InstallDryRun(dry bool)**: Performs a dry run of the installation without making actual changes.
- **InstallReuseName(reuse bool)**: Reuses the release name if it already exists.
- **InstallSubNotes(enable bool)**: Enables the display of sub-notes after installation.
- **InstallTimeout(timeout int64)**: Sets the timeout for the installation operation in seconds.
- **InstallWait(wait bool)**: Waits for the release to be deployed successfully.
- **ReleaseName(name string)**: Specifies the name for the release.
- **ValueOverrides(raw []byte)**: Provides raw byte slice for value overrides.
```

--------------------------------

### Install

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/cmd/helm/installer

Installs Tiller using the provided Kubernetes client and options. Returns an error if the installation fails.

```APIDOC
## Install

### Description
Install uses Kubernetes client to install Tiller. Returns an error if the command failed.

### Signature
```go
func Install(client kubernetes.Interface, opts *Options) error
```
```

--------------------------------

### Example Usage

Source: https://pkg.go.dev/docker-proxy.hotik.asia/kawamuray/prometheus-kafka-consumer-group-exporter

An example of how to use the exporter with a Kafka distribution.

```APIDOC
## Example Usage
```
# Download latest Kafka distribution (if necessary)
$ tar zxvf kafka_LATEST_VERSION.tgz
$ ./kafka_consumer_group_exporter --consumer-group-command-path=./kafka_LATEST_VERSION/bin/kafka-consumer-groups.sh BOOTSTRAP_SERVERS
```
```

--------------------------------

### Install Helm Plugin

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Installs a Helm plugin to the $HELM_HOME directory using a provided Installer interface.

```APIDOC
## Install

### Description
Installs a plugin to $HELM_HOME.

### Function Signature
```
func Install(i Installer) error
```

### Parameters
* **i** (Installer) - The installer implementation to use for the plugin.
```

--------------------------------

### LocalInstaller Path Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Returns the installation path for the locally installed plugin.

```go
func (b *LocalInstaller) Path() string
```

--------------------------------

### ReleaseServer Install Release

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/tiller

Installs a release and stores the corresponding release record.

```go
func (s *ReleaseServer) InstallRelease(c ctx.Context, req *services.InstallReleaseRequest) (*services.InstallReleaseResponse, error)
```

--------------------------------

### VCSInstaller Install

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Installs a plugin from a version control system repository.

```APIDOC
## (*VCSInstaller) Install

### Description
Installs a plugin from a version control system.

### Method Signature
```
func (i *VCSInstaller) Install() error
```

### Returns
* **error** - An error if the installation fails.
```

--------------------------------

### NewForSource Installer

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Creates a new Installer based on the provided source and version.

```APIDOC
## NewForSource

### Description
NewForSource determines the correct Installer for the given source.

### Function Signature
```
func NewForSource(source, version string, home helmpath.Home) (Installer, error)
```

### Parameters
* **source** (string) - The source of the plugin (e.g., URL, local path, repository).
* **version** (string) - The desired version of the plugin.
* **home** (helmpath.Home) - The Helm home directory configuration.

### Returns
* **Installer** - An Installer implementation for the specified plugin.
* **error** - An error if the installer cannot be created.
```

--------------------------------

### Get Starters Path

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm/helmpath

Returns the path to the Helm starter packs directory.

```go
func (h Home) Starters() string
```

--------------------------------

### Example Server URL

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/repo/repotest

Provides an example of the URL format returned by the URL() method.

```plaintext
http://localhost:1776
```

--------------------------------

### StartMetricsServer

Source: https://pkg.go.dev/docker-proxy.hotik.asia/ceph/ceph-csi/pkg/util

Starts the metrics server with the given configuration.

```APIDOC
## StartMetricsServer

### Description
Starts the metrics server.

### Signature
func StartMetricsServer(c *Config)
```

--------------------------------

### Installer Interface

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Defines the contract for installing, updating, and locating Helm client plugins.

```go
type Installer interface {
	// Install adds a plugin to $HELM_HOME.
	Install() error
	// Path is the directory of the installed plugin.
	Path() string
	// Update updates a plugin to $HELM_HOME.
	Update() error
}
```

--------------------------------

### InstallOption

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm

Options for configuring Helm installation.

```APIDOC
## InstallOption

### Description
Allows specifying various settings configurable by the helm client user for overriding the defaults used when running the `helm install` command.

### Type Definition
type InstallOption func(*options)
```

```APIDOC
## InstallDescription

### Description
Specifies the description for the release.

### Method Signature
func InstallDescription(description string) InstallOption
```

```APIDOC
## InstallDisableCRDHook

### Description
Disables CRD hook during installation.

### Method Signature
func InstallDisableCRDHook(disable bool) InstallOption
```

```APIDOC
## InstallDisableHooks

### Description
Disables hooks during installation.

### Method Signature
func InstallDisableHooks(disable bool) InstallOption
```

```APIDOC
## InstallDryRun

### Description
Executes an installation as a dry run.

### Method Signature
func InstallDryRun(dry bool) InstallOption
```

```APIDOC
## InstallReuseName

### Description
Instructs Tiller to re-use an existing name.

### Method Signature
func InstallReuseName(reuse bool) InstallOption
```

```APIDOC
## InstallSubNotes

### Description
Instructs Tiller to render SubChart Notes.

### Method Signature
func InstallSubNotes(enable bool) InstallOption
```

```APIDOC
## InstallTimeout

### Description
Specifies the number of seconds before Kubernetes calls timeout.

### Method Signature
func InstallTimeout(timeout int64) InstallOption
```

```APIDOC
## InstallWait

### Description
Specifies whether or not to wait for all resources to be ready.

### Method Signature
func InstallWait(wait bool) InstallOption
```

```APIDOC
## ReleaseName

### Description
Specifies the name of the release when installing.

### Method Signature
func ReleaseName(name string) InstallOption
```

```APIDOC
## ValueOverrides

### Description
Specifies a list of values to include when installing.

### Method Signature
func ValueOverrides(raw []byte) InstallOption
```

--------------------------------

### Start HTTPS Server with Auto TLS

Source: https://pkg.go.dev/docker.baopinshidai.com/labstack/echo

Starts an HTTPS server using certificates automatically obtained from Let's Encrypt.

```go
func (e *Echo) StartAutoTLS(address string) error
```

--------------------------------

### Simple Example

Source: https://pkg.go.dev/docker-proxy.hotik.asia/casbin/gorm-adapter

Demonstrates how to initialize a Gorm adapter and use it with a Casbin enforcer to load, enforce, and save policies.

```APIDOC
package main

import (
	"github.com/casbin/casbin"
	"github.com/casbin/gorm-adapter"
	_ "github.com/go-sql-driver/mysql"
)

func main() {
	// Initialize a Gorm adapter and use it in a Casbin enforcer:
	// The adapter will use the MySQL database named "casbin".
	// If it doesn't exist, the adapter will create it automatically.
	// You can also use an already existing gorm instance with gormadapter.NewAdapterByDB(gormInstance)
	a := gormadapter.NewAdapter("mysql", "mysql_username:mysql_password@tcp(127.0.0.1:3306)/") // Your driver and data source. 
	e := casbin.NewEnforcer("examples/rbac_model.conf", a)
	
	// Or you can use an existing DB "abc" like this:
    // The adapter will use the table named "casbin_rule".
    // If it doesn't exist, the adapter will create it automatically.
    // a := gormadapter.NewAdapter("mysql", "mysql_username:mysql_password@tcp(127.0.0.1:3306)/abc", true)

	// Load the policy from DB.
	e.LoadPolicy()
	
	// Check the permission.
	e.Enforce("alice", "data1", "read")
	
	// Modify the policy.
	// e.AddPolicy(...)
	// e.RemovePolicy(...)
	
	// Save the policy back to DB.
	e.SavePolicy()
}
```

--------------------------------

### FakeClient Install Helm Release with Context

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm

Creates a new release within the FakeClient from a chart string, accepting a context. This simulates context-aware installations.

```go
func (c *FakeClient) InstallReleaseWithContext(ctx context.Context, chStr, ns string, opts ...InstallOption) (*rls.InstallReleaseResponse, error)
```

--------------------------------

### LocalInstaller Update Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Updates a plugin installed from the local filesystem. Implements the Installer interface.

```go
func (i *LocalInstaller) Update() error
```

--------------------------------

### Simple Gorm Adapter Example

Source: https://pkg.go.dev/docker-proxy.hotik.asia/casbin/gorm-adapter

Demonstrates initializing a Gorm adapter and using it with a Casbin enforcer. The adapter can automatically create the database if it doesn't exist. It also shows how to load, enforce, and save policies.

```go
package main

import (
	"github.com/casbin/casbin"
	"github.com/casbin/gorm-adapter"
	_ "github.com/go-sql-driver/mysql"
)

func main() {
	// Initialize a Gorm adapter and use it in a Casbin enforcer:
	// The adapter will use the MySQL database named "casbin".
	// If it doesn't exist, the adapter will create it automatically.
	// You can also use an already existing gorm instance with gormadapter.NewAdapterByDB(gormInstance)
	a := gormadapter.NewAdapter("mysql", "mysql_username:mysql_password@tcp(127.0.0.1:3306)/") // Your driver and data source. 
	e := casbin.NewEnforcer("examples/rbac_model.conf", a)
	
	// Or you can use an existing DB "abc" like this:
    // The adapter will use the table named "casbin_rule".
    // If it doesn't exist, the adapter will create it automatically.
    // a := gormadapter.NewAdapter("mysql", "mysql_username:mysql_password@tcp(127.0.0.1:3306)/abc", true)

	// Load the policy from DB.
	e.LoadPolicy()
	
	// Check the permission.
	e.Enforce("alice", "data1", "read")
	
	// Modify the policy.
	// e.AddPolicy(...)
	// e.RemovePolicy(...)
	
	// Save the policy back to DB.
	e.SavePolicy()
}

```

--------------------------------

### Create bin directory and navigate

Source: https://pkg.go.dev/docker.fstream.us.kg/dropbox/dbxcli

Creates a 'bin' directory in the home directory and navigates into it. This is part of the installation process for pre-compiled binaries.

```bash
$ mkdir ~/bin
$ cd ~/bin

```

--------------------------------

### Get Cache Directory Function Signature

Source: https://pkg.go.dev/docker.baopinshidai.com/awslabs/amazon-ecr-credential-helper/ecr-login/config

This function retrieves the cache directory path used by the ECR credential helper. No setup is required to call this function.

```go
func GetCacheDir() string
```

--------------------------------

### ReleaseServiceClient Interface

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/proto/hapi/services

Defines the client-side API for the Release Service, allowing users to perform operations like listing releases, getting release status, installing, updating, and uninstalling releases.

```APIDOC
## ReleaseServiceClient Interface

### Description
This interface defines the client API for the Release Service. It allows for operations such as retrieving release history, getting release status and content, updating, installing, and uninstalling releases, rolling back to previous versions, and running release tests.

### Methods
- **ListReleases**: Retrieves release history. Allows filtering by release status (defaults to 'Active').
- **GetReleaseStatus**: Retrieves status information for a specified release.
- **GetReleaseContent**: Retrieves the release content (chart and values) for a specified release.
- **UpdateRelease**: Updates the content of an existing release.
- **InstallRelease**: Requests the installation of a chart as a new release.
- **UninstallRelease**: Requests the deletion of a named release.
- **GetVersion**: Returns the current version of the server.
- **RollbackRelease**: Rolls back a release to a previous version.
- **GetHistory**: Retrieves the history of a specific release.
- **RunReleaseTest**: Executes the tests defined for a named release.
```

--------------------------------

### StartLocalRepo

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/repo

Starts a web server to serve files from a given local path.

```APIDOC
## StartLocalRepo

### Description
Starts a web server and serves files from the given path.

### Function Signature
```go
func StartLocalRepo(path, address string) error
```
```

--------------------------------

### InstallRelease

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/proto/hapi/rudder

Handles the installation of a Helm release.

```APIDOC
## InstallRelease

### Description
Installs a Helm release.

### Request Type
`InstallReleaseRequest`

### Request Fields
- `release` (*release.Release): The release object to install.

### Response Type
`InstallReleaseResponse`

### Response Fields
- `release` (*release.Release): The installed release object.
- `result` (*Result): The result of the installation operation.
```

--------------------------------

### InstallRelease

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/proto/hapi/rudder

Requests installation of a chart as a new release.

```APIDOC
## InstallRelease

### Description
Requests installation of a chart as a new release.

### Request Body
- **in** (*InstallReleaseRequest) - The request object containing details for installation.
```

--------------------------------

### FakeClient Install Helm Release from Chart

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm

Adds a new mock release to the FakeClient from a chart object and returns a mock InstallReleaseResponse. Useful for testing chart-based installations.

```go
func (c *FakeClient) InstallReleaseFromChart(chart *chart.Chart, ns string, opts ...InstallOption) (*rls.InstallReleaseResponse, error)
```

--------------------------------

### FakeClient Install Helm Release from Chart with Context

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm

Adds a new mock release to the FakeClient from a chart object, accepting a context. This allows for cancellable chart-based installations in tests.

```go
func (c *FakeClient) InstallReleaseFromChartWithContext(ctx context.Context, chart *chart.Chart, ns string, opts ...InstallOption) (*rls.InstallReleaseResponse, error)
```

--------------------------------

### FakeClient Install Helm Release

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm

Creates a new release within the FakeClient and returns a mock InstallReleaseResponse. This simulates the installation process.

```go
func (c *FakeClient) InstallRelease(chStr, ns string, opts ...InstallOption) (*rls.InstallReleaseResponse, error)
```

--------------------------------

### ReleaseServer.InstallRelease

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/tiller

Installs a release and stores the release record.

```APIDOC
## ReleaseServer.InstallRelease

### Description
InstallRelease installs a release and stores the release record.

### Method Signature
```go
func (s *ReleaseServer) InstallRelease(c ctx.Context, req *services.InstallReleaseRequest) (*services.InstallReleaseResponse, error)
```
```

--------------------------------

### InstallReleaseRequest Struct

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/proto/hapi/rudder

Defines the request structure for installing a release.

```go
type InstallReleaseRequest struct {
	Release              *release.Release `protobuf:"bytes,1,opt,name=release,proto3" json:"release,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}
```

--------------------------------

### Get Echo Router

Source: https://pkg.go.dev/docker.baopinshidai.com/labstack/echo

Returns the router instance.

```go
func (e *Echo) Router() *Router
```

--------------------------------

### Helm Install Tiller

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/cmd/helm/installer

Installs Tiller using the provided Kubernetes client and options. Returns an error if the installation fails.

```go
func Install(client kubernetes.Interface, opts *Options) error
```

--------------------------------

### VCSInstaller Path Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Returns the installation path for the VCS-installed plugin.

```go
func (b *VCSInstaller) Path() string
```

--------------------------------

### Register GET Route in Group

Source: https://pkg.go.dev/docker.baopinshidai.com/labstack/echo

Registers a GET HTTP method route within the group. Implements Echo#GET() for sub-routes.

```go
func (g *Group) GET(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
```

--------------------------------

### PrintingKubeClient Get Method Signature

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/tiller/environment

Defines the Get method for PrintingKubeClient, which simulates KubeClient's Get operation by printing values.

```go
func (p *PrintingKubeClient) Get(ns string, r io.Reader) (string, error)
```

--------------------------------

### LocalInstaller Path

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Returns the installation path for the LocalInstaller.

```APIDOC
## (*LocalInstaller) Path

### Description
Path returns the directory of the installed plugin.

### Method Signature
```
func (b *LocalInstaller) Path() string
```

### Returns
* **string** - The path to the plugin directory.
```

--------------------------------

### VCSInstaller Path

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Returns the installation path for the VCSInstaller.

```APIDOC
## (*VCSInstaller) Path

### Description
Path returns the directory of the installed plugin.

### Method Signature
```
func (b *VCSInstaller) Path() string
```

### Returns
* **string** - The path to the plugin directory.
```

--------------------------------

### Initialize Default Environment

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/tiller/environment

Creates a new environment instance with default settings.

```go
func New() *Environment
```

--------------------------------

### LocalReleaseModule.Create

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/tiller

Create installs a new release using the local module.

```APIDOC
## LocalReleaseModule.Create

### Description
Create installs a new release using the local module.

### Method
func (m *LocalReleaseModule) Create

### Endpoint
N/A

### Parameters
- **r** (*release.Release) - The release object.
- **req** (*services.InstallReleaseRequest) - The request object for installing a release.
- **...** - Additional parameters.

### Request Example
N/A

### Response
#### Success Response
- **error** - An error if the creation failed, otherwise nil.
```

--------------------------------

### InstallOrder

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/tiller

Defines the order in which manifests should be installed by Kind.

```APIDOC
## InstallOrder

### Description
InstallOrder is the order in which manifests should be installed (by Kind). Those occurring earlier in the list get installed before those occurring later in the list.

### Variable Declaration
```go
var InstallOrder SortOrder = []string{
	"Namespace",
	"NetworkPolicy",
	"ResourceQuota",
	"LimitRange",
	"PodSecurityPolicy",
	"PodDisruptionBudget",
	"Secret",
	"ConfigMap",
	"StorageClass",
	"PersistentVolume",
	"PersistentVolumeClaim",
	"ServiceAccount",
	"CustomResourceDefinition",
	"ClusterRole",
	"ClusterRoleList",
	"ClusterRoleBinding",
	"ClusterRoleBindingList",
	"Role",
	"RoleList",
	"RoleBinding",
	"RoleBindingList",
	"Service",
	"DaemonSet",
	"Pod",
	"ReplicationController",
	"ReplicaSet",
	"Deployment",
	"HorizontalPodAutoscaler",
	"StatefulSet",
	"Job",
	"CronJob",
	"Ingress",
	"APIService",
}
```
```

--------------------------------

### SQL Driver Get Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/storage/driver

Retrieves a release by its key from the SQL database.

```go
func (s *SQL) Get(key string) (*rspb.Release, error)
```

--------------------------------

### ReleaseServer Get Version

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/tiller

Sends the server version information.

```go
func (s *ReleaseServer) GetVersion(c ctx.Context, req *services.GetVersionRequest) (*services.GetVersionResponse, error)
```

--------------------------------

### LocalInstaller

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Manages the installation of local Helm plugins by creating symbolic links.

```APIDOC
## LocalInstaller.Install

### Description
Install creates a symlink to the plugin directory in $HELM_HOME.
Implements Installer.

### Method
func (*LocalInstaller) Install() error

## LocalInstaller.Path

### Description
Path is where the plugin will be symlinked to.

### Method
func (*LocalInstaller) Path() string

## LocalInstaller.Update

### Description
Update updates a local repository.

### Method
func (*LocalInstaller) Update() error
```

--------------------------------

### SetupPluginEnv Function

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin

Prepares the operating system's environment variables for plugin execution.

```APIDOC
## func SetupPluginEnv

### Description
SetupPluginEnv prepares os.Env for plugins. It operates on os.Env because the plugin subsystem itself needs access to the environment variables created here.

### Signature
```go
func SetupPluginEnv(settings helm_env.EnvSettings, shortName, base string)
```
```

--------------------------------

### InstallReleaseRequest

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/proto/hapi/rudder

Represents a request to install a release. It contains the release object to be installed.

```APIDOC
## InstallReleaseRequest

### Description
Represents a request to install a release.

### Fields
- **release** (*release.Release) - The release object to be installed.
```

--------------------------------

### Run Controller Publish Server

Source: https://pkg.go.dev/docker-proxy.hotik.asia/ceph/ceph-csi/pkg/csi-common

Starts the controller publish server. Requires endpoint, driver, controller server implementation, and a boolean for multi-writer support.

```go
func RunControllerPublishServer(endpoint, hstOption string, d *CSIDriver, cs csi.ControllerServer, m bool)

RunControllerPublishServer starts controller server
```

--------------------------------

### Example Usage of the Exporter

Source: https://pkg.go.dev/docker-proxy.hotik.asia/kawamuray/prometheus-kafka-consumer-group-exporter

Demonstrates how to run the exporter, specifying the path to the kafka-consumer-groups.sh script and bootstrap servers.

```bash
# Download latest Kafka distribution (if necessary)
$ tar zxvf kafka_LATEST_VERSION.tgz
$ ./kafka_consumer_group_exporter --consumer-group-command-path=./kafka_LATEST_VERSION/bin/kafka-consumer-groups.sh BOOTSTRAP_SERVERS
```

--------------------------------

### FindSource Installer

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Determines the correct Installer implementation for a given source location.

```APIDOC
## FindSource

### Description
FindSource determines the correct Installer for the given source.

### Function Signature
```
func FindSource(location string, home helmpath.Home) (Installer, error)
```

### Parameters
* **location** (string) - The source location of the plugin.
* **home** (helmpath.Home) - The Helm home directory configuration.

### Returns
* **Installer** - An Installer implementation suitable for the source.
* **error** - An error if the appropriate installer cannot be determined.
```

--------------------------------

### Get Repository File Path

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm/helmpath

Returns the path to the repositories.yaml file.

```go
func (h Home) RepositoryFile() string
```

--------------------------------

### InstallReleaseResponse

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/proto/hapi/services

Represents the response after installing a Helm release. It contains information about the installed release.

```APIDOC
## InstallReleaseResponse

### Description
Represents the response after installing a Helm release. It contains information about the installed release.

### Fields
- **release** (*release.Release) - The installed release object.
```

--------------------------------

### New Environment

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/tiller/environment

Initializes a new Environment with default settings.

```APIDOC
## func New()

### Description
New returns an environment initialized with the defaults.

### Returns
- *Environment: A pointer to the initialized Environment object.
```

--------------------------------

### SetupLogger

Source: https://pkg.go.dev/docker.baopinshidai.com/awslabs/amazon-ecr-credential-helper/ecr-login/config

SetupLogger initializes the logging configuration for the helper.

```APIDOC
## SetupLogger

### Description
Initializes the logging configuration for the ECR credential helper.

### Signature
```
func SetupLogger()
```
```

--------------------------------

### HTTPInstaller Path

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Returns the installation path for the HTTPInstaller, using the plugin name.

```APIDOC
## (HTTPInstaller) Path

### Description
Path is overridden because we want to join on the plugin name not the file name.

### Method Signature
```
func (i HTTPInstaller) Path() string
```

### Returns
* **string** - The path to the plugin directory.
```

--------------------------------

### HTTPInstaller Install

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Downloads and extracts a tarball from a URL, then creates a symlink to the plugin directory in $HELM_HOME.

```APIDOC
## (*HTTPInstaller) Install

### Description
Downloads and extracts the tarball into the cache directory and creates a symlink to the plugin directory in $HELM_HOME.

### Method Signature
```
func (i *HTTPInstaller) Install() error
```

### Returns
* **error** - An error if the installation fails.
```

--------------------------------

### Create Repository Server

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/repo/repotest

Creates a new repository server instance. The docroot should be a temporary directory managed by the caller. This function starts the server and serves files from the specified docroot. Use CopyCharts to add charts and then index them.

```go
func NewServer(docroot string) *Server
```

--------------------------------

### InstallReleaseResponse

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/proto/hapi/services

Represents the response received after installing a Helm release. It contains the details of the installed release.

```APIDOC
## InstallReleaseResponse

### Description
InstallReleaseResponse is the response from a release installation.

### Fields
- **release** (*release.Release) - The details of the installed release.
```

--------------------------------

### Example Usage of VersionSet.Has

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/chartutil

Demonstrates how to check for the presence of a specific API version within a VersionSet.

```go
vs.Has("extensions/v1beta1")
```

--------------------------------

### VCSInstaller Update Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Updates a plugin installed from a VCS repository. Implements the Installer interface.

```go
func (i *VCSInstaller) Update() error
```

--------------------------------

### FakeClient.InstallReleaseWithContext

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm

Creates a new release, returns a InstallReleaseResponse, and accepts a context.

```APIDOC
## FakeClient.InstallReleaseWithContext

### Description
InstallReleaseWithContext creates a new release and returns a InstallReleaseResponse containing that release and accepts a context.

### Method Signature
func (c *FakeClient) InstallReleaseWithContext(ctx context.Context, chStr, ns string, opts ...InstallOption) (*rls.InstallReleaseResponse, error)
```

--------------------------------

### Build the drone-gitea-release Binary and Docker Image

Source: https://pkg.go.dev/docker-proxy.hotik.asia/drone-plugins/drone-gitea-release

Use these commands to build the Go binary for Linux amd64 and then build the Docker image for the plugin.

```bash
GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -a -tags netgo -o release/linux/amd64/drone-gitea-release
```

```bash
docker build --rm -t plugins/gitea-release .
```

--------------------------------

### FindSource Function

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Determines the appropriate Installer implementation for a given plugin source location.

```go
func FindSource(location string, home helmpath.Home) (Installer, error)
```

--------------------------------

### Run Static Analysis Tools

Source: https://pkg.go.dev/docker-proxy.hotik.asia/kawamuray/prometheus-kafka-consumer-group-exporter

Installs golint and runs go vet, gofmt, and golint to ensure code quality before submitting pull requests.

```bash
$ go get -u github.com/golang/lint/golint
$ golint ./...
$ ./check_gofmt.sh
$ go vet ./...
```

--------------------------------

### GET Route Registration

Source: https://pkg.go.dev/docker.baopinshidai.com/labstack/echo

Registers a GET route for a specific path with a handler and optional middleware.

```go
func (e *Echo) GET(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
```

--------------------------------

### InstallReleaseResponse String Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/proto/hapi/rudder

Returns a string representation of the InstallReleaseResponse. This is a generated method.

```go
func (m *InstallReleaseResponse) String() string
```

--------------------------------

### NewHTTPInstaller Function

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Creates a new HTTPInstaller. Requires the source URL and Helm home directory.

```go
func NewHTTPInstaller(source string, home helmpath.Home) (*HTTPInstaller, error)
```

--------------------------------

### Setup for Developing prometheus-kafka-consumer-group-exporter

Source: https://pkg.go.dev/docker-proxy.hotik.asia/kawamuray/prometheus-kafka-consumer-group-exporter

Clones the repository, checks out a new branch, and runs tests to ensure a working development environment.

```bash
$ go get github.com/kawamuray/prometheus-kafka-consumer-group-exporter
$ cd $GOPATH/src/github.com/kawamuray/prometheus-kafka-consumer-group-exporter
$ git checkout -b my-new-feature
$ go test -v ./...    # Run tests to make sure you have a good development environment and all works.
```

--------------------------------

### Install chronic using Homebrew

Source: https://pkg.go.dev/docwhat.org/chronic

Install the chronic tool via Homebrew by adding the custom tap.

```bash
brew install docwhat/tap/chronic

```

--------------------------------

### New HTTPInstaller

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Creates a new HTTPInstaller for downloading and installing plugins from a web server.

```APIDOC
## NewHTTPInstaller

### Description
Creates a new HttpInstaller.

### Function Signature
```
func NewHTTPInstaller(source string, home helmpath.Home) (*HTTPInstaller, error)
```

### Parameters
* **source** (string) - The URL of the plugin archive.
* **home** (helmpath.Home) - The Helm home directory configuration.

### Returns
* **(*HTTPInstaller)** - A pointer to the initialized HTTPInstaller.
* **error** - An error if the installer cannot be created.
```

--------------------------------

### InitTLS Method for EnvSettings

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm/environment

Initializes TLS-related settings from the environment variables.

```go
func (s *EnvSettings) InitTLS(fs *pflag.FlagSet)
```

--------------------------------

### Run Node Publish Server

Source: https://pkg.go.dev/docker-proxy.hotik.asia/ceph/ceph-csi/pkg/csi-common

Starts the node publish server. Requires endpoint, driver, node server, and a boolean for multi-writer support.

```go
func RunNodePublishServer(endpoint, hstOption string, d *CSIDriver, ns csi.NodeServer, m bool)

RunNodePublishServer starts node server
```

--------------------------------

### Run Controller and Node Publish Servers

Source: https://pkg.go.dev/docker-proxy.hotik.asia/ceph/ceph-csi/pkg/csi-common

Starts both the controller and node publish servers. Requires endpoint, driver, controller server, node server, and a boolean for multi-writer support.

```go
func RunControllerandNodePublishServer(endpoint, hstOption string, d *CSIDriver, cs csi.ControllerServer, ns csi.NodeServer, m bool)

RunControllerandNodePublishServer starts both controller and node server
```

--------------------------------

### Get chronic source code

Source: https://pkg.go.dev/docwhat.org/chronic

Fetch the source code for the chronic package using 'go get'.

```go
go get docwhat.org/chronic

```

--------------------------------

### YAML Data Example

Source: https://pkg.go.dev/docwhat.org/temple

Example of a YAML file structure that can be used with the -d flag for data injection.

```yaml
key: "value"
key2: 2


```

--------------------------------

### JSON Data Example

Source: https://pkg.go.dev/docwhat.org/temple

Example of a JSON file structure that can be used with the -d flag for data injection.

```json
{
  "key": "value",
  "key2": 2
}


```

--------------------------------

### NewLocalInstaller Function

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Creates a new LocalInstaller. Requires the source path and Helm home directory.

```go
func NewLocalInstaller(source string, home helmpath.Home) (*LocalInstaller, error)
```

--------------------------------

### InstallReleaseRequest String Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/proto/hapi/rudder

Returns a string representation of the InstallReleaseRequest.

```go
func (m *InstallReleaseRequest) String() string
```

--------------------------------

### InstallReleaseResponse Go Struct

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/proto/hapi/services

Defines the structure for the response when a Helm release is installed. It contains the installed release object.

```go
type InstallReleaseResponse struct {
	Release              *release.Release `protobuf:"bytes,1,opt,name=release,proto3" json:"release,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}
```

--------------------------------

### InstallReleaseRequest

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/proto/hapi/services

Represents the request structure for installing a Helm release. It includes details about the chart, values, and installation options.

```APIDOC
## InstallReleaseRequest

### Description
Represents the request for an installation of a chart. This structure contains all necessary information to perform a release installation.

### Fields
- **chart** (*chart.Chart*) - The protobuf representation of a chart.
- **values** (*chart.Config*) - A string containing (unparsed) YAML values for the chart.
- **dryRun** (*bool*) - If true, simulates the release logic without creating a release object or deploying to Kubernetes. The returned release object will be fake.
- **name** (*string*) - The candidate release name. Must be unique to the namespace. If not supplied, the server will autogenerate one.
- **disableHooks** (*bool*) - If true, skips running any hooks for the install.
- **namespace** (*string*) - The Kubernetes namespace for the release.
- **reuseName** (*bool*) - Requests that Tiller re-uses a name instead of erroring out.
- **timeout** (*int64*) - Specifies the maximum amount of time any Kubernetes client command can run.
- **wait** (*bool*) - If true, waits until all Pods, PVCs, and Services are in a ready state before marking the release as successful. It will wait for as long as the timeout.
- **disableCrdHook** (*bool*) - Disables the running of CRD hooks during installation.
- **description** (*string*) - If set, this value will be used as the description for the installed release.
- **subNotes** (*bool*) - Controls whether sub-notes are included.
```

--------------------------------

### SQL Driver Create Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/storage/driver

Creates a new release in the SQL database.

```go
func (s *SQL) Create(key string, rls *rspb.Release) error
```

--------------------------------

### Extract Commits from Repository using go-git

Source: https://pkg.go.dev/docker.baopinshidai.com/src-d/go-git

This example demonstrates how to initialize a repository, pull the latest changes, and iterate through its commits. Ensure proper error handling for network operations and iteration.

```go
func ExampleBasic_printCommits() {
  r, err := git.NewRepository("https://github.com/src-d/go-git", nil)
  if err != nil {
  	panic(err)
  }

  if err := r.Pull("origin", "refs/heads/master"); err != nil {
  	panic(err)
  }

  iter := r.Commits()
  defer iter.Close()

  for {
  	commit, err := iter.Next()
  	if err != nil {
  		if err == io.EOF {
  			break
  		}

  		panic(err)
  	}

  	fmt.Println(commit)
  }
}
```

--------------------------------

### HttpGetter Get Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/getter

Implements the Get method for HttpGetter, retrieving content from a specified URL and returning it as a bytes.Buffer.

```go
func (g *HttpGetter) Get(href string) (*bytes.Buffer, error)
```

--------------------------------

### Init Method for EnvSettings

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/helm/environment

Initializes EnvSettings by setting values from the environment variables.

```go
func (s *EnvSettings) Init(fs *pflag.FlagSet)
```

--------------------------------

### InstallReleaseRequest

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/proto/hapi/services

Represents a request to install a Helm release. It includes details about the chart, release name, namespace, and installation options.

```APIDOC
## InstallReleaseRequest

### Description
Represents a request to install a Helm release. It includes details about the chart, release name, namespace, and installation options.

### Fields
- **name** (string) - The name of the release to install.
- **namespace** (string) - The namespace to install the release into.
- **chart** (*chart.Chart) - The chart to install.
- **values** (*chart.Config) - The values to use for the installation.
- **dry_run** (bool) - Whether to perform a dry run.
- **disable_hooks** (bool) - Whether to disable hooks.
- **disable_crd_hook** (bool) - Whether to disable CRD hooks.
- **sub_notes** (bool) - Whether to include sub-notes.
- **wait** (bool) - Whether to wait for the release to be ready.
- **timeout** (int64) - The timeout for the installation.
- **reuse_name** (bool) - Whether to reuse the release name if it already exists.
- **description** (string) - A description for the release.
```

--------------------------------

### NewSQL Constructor

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/storage/driver

Initializes a new SQL storage driver.

```APIDOC
## NewSQL

### Description
NewSQL initializes a new memory driver.

### Signature
func NewSQL(dialect, connectionString string, logger func(string, ...interface{})) (*SQL, error)
```

--------------------------------

### Start Metric Construction (Go)

Source: https://pkg.go.dev/docker-proxy.hotik.asia/blind-oracle/riemann-relay/flatb

Begins the construction of a Flatbuffers metric. Call this before adding metric fields.

```go
func MetricStart(builder *flatbuffers.Builder)
```

--------------------------------

### StartMetricsServer

Source: https://pkg.go.dev/docker-proxy.hotik.asia/ceph/ceph-csi/pkg/util

Starts the HTTP metrics server. Requires a configuration object. Added in v1.2.0.

```APIDOC
## StartMetricsServer

### Description
Starts the HTTP server for metrics.

### Signature
```go
func StartMetricsServer(c *Config)
```

### Version Added
v1.2.0
```

--------------------------------

### MockCredentialsCache Get Method

Source: https://pkg.go.dev/docker.baopinshidai.com/awslabs/amazon-ecr-credential-helper/ecr-login/cache/mocks

Retrieves an authentication entry from the mock cache based on a provided key. This is a mock implementation of the Get method.

```go
func (_m *MockCredentialsCache) Get(_param0 string) *cache.AuthEntry
```

--------------------------------

### ECRHelper Get Method Signature

Source: https://pkg.go.dev/docker.baopinshidai.com/awslabs/amazon-ecr-credential-helper/ecr-login

Provides the signature for the Get method of ECRHelper. This method retrieves credentials for a given server URL.

```go
func (self ECRHelper) Get(serverURL string) (string, string, error)
```

--------------------------------

### Hooks Get Method Signature

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin

Signature for the Get method on the Hooks type, which retrieves a command string associated with a given event.

```go
func (hooks Hooks) Get(event string) string
```

--------------------------------

### HTTPInstaller Path Method

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/plugin/installer

Returns the installation path for the HTTP-installed plugin. Overridden to use the plugin name.

```go
func (i HTTPInstaller) Path() string
```

--------------------------------

### InstallOrder Variable Definition

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/tiller

InstallOrder is a SortOrder defining the sequence for installing Kubernetes manifests by Kind. Items earlier in the list are installed first.

```go
var InstallOrder SortOrder = []string{
	"Namespace",
	"NetworkPolicy",
	"ResourceQuota",
	"LimitRange",
	"PodSecurityPolicy",
	"PodDisruptionBudget",
	"Secret",
	"ConfigMap",
	"StorageClass",
	"PersistentVolume",
	"PersistentVolumeClaim",
	"ServiceAccount",
	"CustomResourceDefinition",
	"ClusterRole",
	"ClusterRoleList",
	"ClusterRoleBinding",
	"ClusterRoleBindingList",
	"Role",
	"RoleList",
	"RoleBinding",
	"RoleBindingList",
	"Service",
	"DaemonSet",
	"Pod",
	"ReplicationController",
	"ReplicaSet",
	"Deployment",
	"HorizontalPodAutoscaler",
	"StatefulSet",
	"Job",
	"CronJob",
	"Ingress",
	"APIService",
}
```

--------------------------------

### New Repository

Source: https://pkg.go.dev/docker.baopinshidai.com/src-d/go-git

Creates a new repository, setting the specified URL as the default remote.

```go
func NewRepository(url string, auth common.AuthMethod) (*Repository, error)
```

--------------------------------

### Get File Content as String

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/chartutil

Use the Get method of the Files type to retrieve the content of a specific file as a string, given its name.

```go
content := f.Get(name string)
```

--------------------------------

### Initialize Default Controller Server

Source: https://pkg.go.dev/docker-proxy.hotik.asia/ceph/ceph-csi/pkg/csi-common

Initializes a default controller server with the provided CSIDriver.

```go
func NewDefaultControllerServer(d *CSIDriver) *DefaultControllerServer

NewDefaultControllerServer initializes default controller server
```

--------------------------------

### Helm Tiller Installation Options

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/cmd/helm/installer

Defines the configuration options for installing Tiller into a Kubernetes cluster. These options control TLS settings, image selection, namespace, service account, and more.

```go
type Options struct {
	// EnableTLS instructs Tiller to serve with TLS enabled.
	//
	// Implied by VerifyTLS. If set the TLSKey and TLSCert are required.
	EnableTLS bool

	// VerifyTLS instructs Tiller to serve with TLS enabled verify remote certificates.
	//
	// If set TLSKey, TLSCert, TLSCaCert are required.
	VerifyTLS bool

	// UseCanary indicates that Tiller should deploy using the latest Tiller image.
	UseCanary bool

	// Namespace is the Kubernetes namespace to use to deploy Tiller.
	Namespace string

	// ServiceAccount is the Kubernetes service account to add to Tiller.
	ServiceAccount string

	// AutoMountServiceAccountToken determines whether or not the service account should be added to Tiller.
	AutoMountServiceAccountToken bool

	// ForceUpgrade allows to force upgrading tiller if deployed version is greater than current version
	ForceUpgrade bool

	// ImageSpec identifies the image Tiller will use when deployed.
	//
	// Valid if and only if UseCanary is false.
	ImageSpec string

	// TLSKeyFile identifies the file containing the pem encoded TLS private
	// key Tiller should use.
	//
	// Required and valid if and only if EnableTLS or VerifyTLS is set.
	TLSKeyFile string

	// TLSCertFile identifies the file containing the pem encoded TLS
	// certificate Tiller should use.
	//
	// Required and valid if and only if EnableTLS or VerifyTLS is set.
	TLSCertFile string

	// TLSCaCertFile identifies the file containing the pem encoded TLS CA
	// certificate Tiller should use to verify remotes certificates.
	//
	// Required and valid if and only if VerifyTLS is set.
	TLSCaCertFile string

	// EnableHostNetwork installs Tiller with net=host.
	EnableHostNetwork bool

	// MaxHistory sets the maximum number of release versions stored per release.
	//
	// Less than or equal to zero means no limit.
	MaxHistory int

	// Replicas sets the amount of Tiller replicas to start
	//
	// Less than or equals to 1 means 1.
	Replicas int

	// NodeSelectors determine which nodes Tiller can land on.
	NodeSelectors string

	// Output dumps the Tiller manifest in the specified format (e.g. JSON) but skips Helm/Tiller installation.
	Output OutputFormat

	// Set merges additional values into the Tiller Deployment manifest.
	Values []string
}

```

--------------------------------

### Helm Storage Init Function

Source: https://pkg.go.dev/docker-proxy.hotik.asia/helm/helm/pkg/storage

Initializes a new storage backend with the provided driver. If the driver is nil, the default in-memory driver is used.

```go
func Init(d driver.Driver) *Storage
```
Tokens:
Raw