sidecars

package module
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 11, 2023 License: Apache-2.0 Imports: 23 Imported by: 0

README

Cloud-sidecars Build Status

A CLI tool to run sidecars inside an app on different cloud environment. Sidecar will be run locally inside your app and will run real app with configuration set by sidecar.

If sidecar is a reverse proxy, it will overwrite real app configuration to make run your reverse proxy in front of the app.

For now it only support 2 types:

  • Cloud foundry through its buildpack
  • Locally only for testing purpose before run

installation

On cloud foundry

Use buildpack associated: https://github.com/orange-cloudfoundry/sidecars-buildpack

You can also install locally to be able to run cloud-sidecar vendor to vendor all sidecars in local for offline app.

Locally
On *nix system

You can install this via the command-line with either curl or wget.

via curl
$ bash -c "$(curl -fsSL https://raw.github.com/orange-cloudfoundry/cloud-sidecars/master/bin/install.sh)"
via wget
$ bash -c "$(wget https://raw.github.com/orange-cloudfoundry/cloud-sidecars/master/bin/install.sh -O -)"
On windows

You can install it by downloading the .exe corresponding to your cpu from releases page: https://github.com/cloud-sidecars/terraform-secure-backend/releases . Alternatively, if you have a terminal interpreting shell you can also use command line script above, it will download file in your current working dir.

Commands

NAME:
   cloud-sidecar - Cloud sidecar cli

USAGE:
   cloud-sidecars [global options] command [command options] [arguments...]

VERSION:
   0.0.0

COMMANDS:
     launch   launch all sidecar and main process, must be run as start command
     vendor   Vendor all sidecars in local for offline app
     setup    Download sidecars if needed and create profiled files, this should be run by a staging lifecycle (e.g.: cloud foundry buildpack lifecycle)
     sha1     See sha1 corresponding to your artifacts
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --config-path value, -c value  Path to the config file (This file will not be used in a cloud env like Cloud Foundry, Heroku or kubernetes) (default: "sidecars-config.yml") [$CONFIG_FILE]
   --dir value, -d value          Set directory where to perform commands
   --log-level value, -l value    Log level to use
   --cloud-env value              Force cloud env detection
   --log-json, -j                 Write log in json
   --no-color                     Logger will not display colors
   --profile-dir value            Set path where to put profiled files
   --app-port value               App listen port by default when not found from starter (default: 8080)
   --help, -h                     show help
   --version, -v                  print the version

Usage

By default configuration can be write as a file named sidecars-config.yml but it use gautocloud for loading configuration. You could use instead a cups service named sidecar-config for cloud foundry or SIDECAR_CONFIG_<PARAM> for heroku/k8s.

Here the configuration file in sidecars-config.yml with exemple for gobis-server:

# Set to true to not use colors in logs output
no_color: false
# Set debug level (debug, info, warn, error level
log_level: info
# Set to true to show logs as json
log_json: false
# Set to true to not run app
no_starter: false
# Base directory to launch sidecars processes (where .sidecars directory is placed)
# Cloud-sidecar cli will automatically found base dir by looking .sidecars directory in current wd or sub folders
dir: "" 
# App listen port by default when not found from starter
# E.g.: during setup on cloud foundry env var PORT is not set but 
# we need to know app port when using sidecar as reverse proxy
app_port: 8080
sidecars:
  # Name must be defined for your sidecar
- name: gobis-server
  # Path to execute your sidecar (You can run binary set in PATH)
  # If artifact_url is set, executable path is prefixed directly with download path by cloud-sidecars
  executable: gobis-server
  # This can be empty, it let you download an artifact. Artifacts are unzipped and placed at <dir>/.sidecars/<sidecar name>
  # executable path is prefixed directly with this path by cloud-sidecars
  # work dir for after_download is this directory: <dir>/.sidecars/<sidecar name>
  # It uses https://github.com/ArthurHlt/zipper for downloading artifacts this let you download git, zip, tar, tgz or any other file (they all be uncompressed)
  artifact_uri: https://github.com/orange-cloudfoundry/gobis-server/releases/download/v1.7.0/gobis-server_linux_amd64.zip
  # force type detection for https://github.com/ArthurHlt/zipper
  artifact_type: http
  # Sha1 to ensure to have correct downloaded artifact
  # This is specific sha1 made by zipper, use cloud-sidecars sha1 command to have sha1 to insert here
  artifact_sha1: ""
  # Run script after setup your artifact
  # here it renames gobis-server_linux_amd64 to gobis-server
  after_install: "mv * gobis-server"
  # pass args to executable
  args: 
  - "--sidecar"
  - "--sidecar-app-port"
  # this sidecar is defines as reverse proxy, it give a PROXY_APP_PORT env var
  # as bellow you can give args in posix style from env var
  - "${PROXY_APP_PORT}"
  # Set env var for sidecar
  # you can give a value in posix style from env var
  env:
    FOO: "${PATH}"
    KEY: "val"
  # Set env var for app, all app_env found in sidecars will be merged in one
  # you can give a value in posix style from env var
  app_env: {}
  # You can pass a profile file which will be source before executing app
  profiled: ""
  # Set working directory, by defaul it is the dir defined by cli flag --dir
  work_dir: ""
  # Do not put prefix in stdout/stderr for this sidecar
  no_log_prefix: false
  # If true this will override listen port for app and set an PROXY_APP_PORT env var for sidecar
  # If you have multiple sidecar of type reverse proxy it will chain in the order set here.
  is_rproxy: true
  # If true when your sidecar stop it will not stop main app and others sidecars
  no_interrupt_when_stop: false

Documentation

Index

Constants

View Source 
const (
	ProxyAppPortEnvKey = "PROXY_APP_PORT"
	AppPortEnvKey      = "SIDECAR_APP_PORT"
	PathSidecarsWd     = ".sidecars"
)

Variables

This section is empty.

Functions

func DownloadArtifact 

func DownloadArtifact(zipFilePath, uri, fileType, sha1 string) error

func DownloadSidecar 

func DownloadSidecar(zipFilePath string, c *config.Sidecar) error

func IndexFilePath added in v0.4.0 

func IndexFilePath(baseDir string) string

func NewSidecarError added in v0.2.0 

func NewSidecarError(s *config.Sidecar, err error) *sidecarError

func OverrideEnv added in v0.2.1 

func OverrideEnv(old, new map[string]string) (map[string]string, error)

func PrefixCmdOutput 

func PrefixCmdOutput(stdout, stderr io.Writer, cmd *exec.Cmd, prefix string) error

func SidecarDir 

func SidecarDir(baseDir, sidecarName string) string

func SidecarExecPath added in v0.2.1 

func SidecarExecPath(origWd string, sidecar *config.Sidecar) string

func TemplatingArgs added in v0.2.1 

func TemplatingArgs(env map[string]string, args ...string) ([]string, error)

func TemplatingEnv added in v0.2.1 

func TemplatingEnv(old, new map[string]string) (map[string]string, error)

func TemplatingFromEnv added in v0.2.1 

func TemplatingFromEnv(env map[string]string, s string) (string, error)

func ZipperSess added in v0.2.0 

func ZipperSess(uri, fileType string) (*zipper.Session, error)

Types

type CmdHandler added in v0.4.0 

type CmdHandler interface {
	Run() error
	Start() error
	Wait() error
}

func NoOpCmdHandlerFactory added in v0.4.0 

func NoOpCmdHandlerFactory(cmd *exec.Cmd) (CmdHandler, error)

type CmdHandlerFactory added in v0.4.0 

type CmdHandlerFactory func(*exec.Cmd) (CmdHandler, error)

type CmdWriter 

type CmdWriter struct {
	// contains filtered or unexported fields
}

type Index added in v0.4.0 

type Index struct {
	Name    string `yaml:"name"`
	ZipFile string `yaml:"zip_file"`
	Uri     string `yaml:"uri"`
	Sha1    string `yaml:"sha1"`
}

func (Index) IsDiff added in v0.4.0 

func (i Index) IsDiff(sha1 string) bool

type Indexer added in v0.4.0 

type Indexer struct {
	// contains filtered or unexported fields
}

func NewIndexer added in v0.4.0 

func NewIndexer(indexFile string) *Indexer

func (Indexer) HasIndexFile added in v0.4.0 

func (i Indexer) HasIndexFile() bool

func (Indexer) Index added in v0.4.0 

func (i Indexer) Index(sidecar *config.Sidecar) (Index, bool)

func (Indexer) IndexToRemove added in v0.4.0 

func (i Indexer) IndexToRemove(sidecar []*config.Sidecar) []Index

func (Indexer) Indexes added in v0.4.0 

func (i Indexer) Indexes() []Index

func (*Indexer) RemoveIndex added in v0.4.0 

func (i *Indexer) RemoveIndex(index Index)

func (Indexer) ShouldDownload added in v0.4.0 

func (i Indexer) ShouldDownload(sidecar *config.Sidecar) (ok bool, why string)

func (*Indexer) Store added in v0.4.0 

func (i *Indexer) Store() error

func (*Indexer) UpdateOrCreateIndex added in v0.4.0 

func (i *Indexer) UpdateOrCreateIndex(sidecar *config.Sidecar, zipFile string) error

type Launcher 

type Launcher struct {
	// contains filtered or unexported fields
}

func NewLauncher 

func NewLauncher(
	sConfig config.Sidecars,
	cStarter starter.Starter,
	profileDir string,
	stdout, stderr io.Writer,
	defaultAppPort int,
) *Launcher

func (Launcher) CreateProcesses added in v0.3.0 

func (l Launcher) CreateProcesses() (processLen int, processes []*process, err error)

func (Launcher) DownloadArtifacts 

func (l Launcher) DownloadArtifacts() error

func (Launcher) Launch 

func (l Launcher) Launch() error

func (Launcher) Setup 

func (l Launcher) Setup() error

func (Launcher) ShowSidecarsSha1 added in v0.2.0 

func (l Launcher) ShowSidecarsSha1() error

type ProcessFactory added in v0.2.1 

type ProcessFactory struct {
	// contains filtered or unexported fields
}

func NewProcessFactory added in v0.2.1 

func NewProcessFactory(
	stdout, stderr io.Writer,
	cStarter starter.Starter,
	wd string) *ProcessFactory

func (*ProcessFactory) ErrorChan added in v0.3.0 

func (f *ProcessFactory) ErrorChan() chan error

func (*ProcessFactory) FromSidecar added in v0.2.1 

func (f *ProcessFactory) FromSidecar(sidecar *config.Sidecar, env map[string]string) (*process, error)

func (*ProcessFactory) FromStarter added in v0.2.1 

func (f *ProcessFactory) FromStarter(env map[string]string, profileDir string) (*process, error)

func (*ProcessFactory) SetCmdHandlerFactory added in v0.4.0 

func (f *ProcessFactory) SetCmdHandlerFactory(cmdFactory CmdHandlerFactory)

func (*ProcessFactory) SignalChan added in v0.3.0 

func (f *ProcessFactory) SignalChan() chan os.Signal

func (*ProcessFactory) WaitGroup added in v0.3.0 

func (f *ProcessFactory) WaitGroup() *sync.WaitGroup

type Unzip 

type Unzip struct {
	Src  string
	Dest string
}

func NewUnzip 

func NewUnzip(src string, dest string) Unzip

func (Unzip) Extract 

func (uz Unzip) Extract() error

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.