Spread Commands
This page will give you an overview of Spread's current functionality.
For a more in-depth look, see our Godocs.
spread deploy
name
spread deploy - deploys all objects in a directory to a Kubernetes cluster
synopsis
`spread deploy [-s] PATH | COMMIT [kubectl context]1
description
Deploys all objects in a directory (local or remote) to a Kubernetes cluster
The order of operations for actions taken by spread deploy:
- Reads context of directory and builds Kubernetes deployment hierarchy.
- Updates all Kubernetes objects on a Kubernetes cluster.
- Returns an IP address (remote) or port (local), if type Load Balancer is specified.
spread cluster
name
spread cluster - sets up a local Kubernetes cluster
synopsis
spread cluster (start | stop) [-t]
description
Starts and stops localkube, a local Kubernetes cluster
options
-t "latest" specifies localkube image tag to use, default is latest
spread add
name
spread add - stage objects to the index
synopsis
spread add <objectType/objectName>
description
Stage objects to the index
options
--namespace "default" namespace to look for objects
--context kubectl context to use for requests
--no-export don't request Kube API server to export objects
spread commit
name
spread commit - create new commit based on current index
synopsis
spread commit -m <"msg">
description
Create new commit based on the current index and add a commit message
options
-m Message to store the commit with
spread push
name
spread push - Push references to a remote
synopsis
spread push <remote> <refSpec>
description
Push references to a remote
spread pull
name
spread pull - Pull spread data from a remote branch
synopsis
spread pull <remote> <branch>
description
Incorporates changes from a remote repository into the current branch.
spread remote
name
spread remote - View/modify versioning remotes
synopsis
spread remote (add <name> <url> | remove <name> | set-url <name> <url>)
description
Manages repository remote
options
-m Message to store the commit with
spread diff
name
spread diff - diff index against the state of the cluster
description
Diffs index against the state of the cluster
options
--context kubectl context to use for requests
spread status
name
spread status
description
Information about what's commited, changed, and staged.
spread init
name
spread init
synopsis
spread init <path>
description
Create a new spread repository in the given directory. If none is given, the working directory will be used.
spread git
name
spread git - allows access to Git commands while Spread is being built out
description
Allows access to Git commands while Spread is being built out.
options
--context kubectl context to use for requests
spread link
name
spread link - create/remove links on index
synopsis
spread link <target-url> <attach-point>
spread param
name
spread param - Set parameters for field values in the index
synopsis
spread param [-l | -f | -d] <SRI> <name> <prompt>
options
-l list parameters
-f set Golang format string to use with arguments
-d set default value, interpreted as JSON
discussion
An SRI represents a parsed Spread Resource Identifier (SRI), a globally unique address for an document or field stored within a repository.
Updated less than a minute ago