util

Documentation

Index

• Constants
• func ApplyChaincodeSecrets(ctx context.Context, logger *log.CmdLogger, secretsClient v1.SecretInterface, ...) error
• func CopyImageJSON(logger *log.CmdLogger, src, dest string) error
• func CopyIndexFiles(logger *log.CmdLogger, src, dest string) error
• func CopyMetadataDir(logger *log.CmdLogger, src, dest string) error
• func CreateChaincodeJob(ctx context.Context, logger *log.CmdLogger, ...) (*batchv1.Job, error)
• func GetKubeClientset(logger *log.CmdLogger, kubeconfigPath string) (*kubernetes.Clientset, error)
• func GetKubeNamespace() (string, error)
• func GetOptionalEnv(key, defaultValue string) string
• func GetRequiredEnv(key string) (string, error)
• func GetValidRfc1035LabelName(prefix, peerID string, chaincodeData *ChaincodeJSON, suffixLen int) string
• func WaitForChaincodeJob(ctx context.Context, logger *log.CmdLogger, client cache.Getter, ...) error
• type ChaincodeJSON
  • func ReadChaincodeJSON(logger *log.CmdLogger, dir string) (*ChaincodeJSON, error)
• type ChaincodePackageID
  • func NewChaincodePackageID(chaincodeID string) *ChaincodePackageID
• type ImageJSON
  • func ReadImageJSON(logger *log.CmdLogger, dir string) (*ImageJSON, error)
• type MetadataJSON
  • func ReadMetadataJSON(logger *log.CmdLogger, dir string) (*MetadataJSON, error)

Constants

const (
	ChaincodeNamespaceVariable      = builderVariablePrefix + "NAMESPACE"
	ObjectNamePrefixVariable        = builderVariablePrefix + "OBJECT_NAME_PREFIX"
	ChaincodeServiceAccountVariable = builderVariablePrefix + "SERVICE_ACCOUNT"
	DebugVariable                   = builderVariablePrefix + "DEBUG"
	KubeconfigPathVariable          = "KUBECONFIG_PATH"
	PeerIDVariable                  = "CORE_PEER_ID"
)

const (
	ChaincodeFile = "chaincode.json"
	ImageFile     = "image.json"
	MetadataFile  = "metadata.json"
	MetadataDir   = "META-INF"
)

const (
	ObjectNameSuffixLength int = 5

	// Defaults.
	DefaultNamespace          string = "default"
	DefaultObjectNamePrefix   string = "hlfcc"
	DefaultServiceAccountName string = "default"

	// Mutual TLS auth client key and cert paths in the chaincode container.
	TLSClientKeyPath      string = "/etc/hyperledger/fabric/client.key"
	TLSClientCertPath     string = "/etc/hyperledger/fabric/client.crt"
	TLSClientKeyFile      string = "/etc/hyperledger/fabric/client_pem.key"
	TLSClientCertFile     string = "/etc/hyperledger/fabric/client_pem.crt"
	TLSClientRootCertFile string = "/etc/hyperledger/fabric/peer.crt"
)

Functions

func ApplyChaincodeSecrets

func ApplyChaincodeSecrets(
	ctx context.Context,
	logger *log.CmdLogger,
	secretsClient v1.SecretInterface,
	secretName, namespace, peerID string,
	chaincodeData *ChaincodeJSON,
) error

func CopyImageJSON

func CopyImageJSON(logger *log.CmdLogger, src, dest string) error

CopyImageJSON validates and copies the chaincode image file.

func CopyIndexFiles

func CopyIndexFiles(logger *log.CmdLogger, src, dest string) error

CopyIndexFiles copies CouchDB index definitions from source to destination directories.

func CopyMetadataDir

func CopyMetadataDir(logger *log.CmdLogger, src, dest string) error

CopyMetadataDir copies all chaincode metadata from source to destination directories.

func CreateChaincodeJob

func CreateChaincodeJob(
	ctx context.Context,
	logger *log.CmdLogger,
	jobsClient typedBatchv1.JobInterface,
	objectName, namespace, serviceAccount, peerID string,
	chaincodeData *ChaincodeJSON,
	imageData *ImageJSON,
) (*batchv1.Job, error)

func GetKubeClientset

func GetKubeClientset(logger *log.CmdLogger, kubeconfigPath string) (*kubernetes.Clientset, error)

GetKubeClientset returns a client object for a provided kubeconfig filepath if one is provided, or which uses the service account kubernetes gives to pods otherwise.

func GetKubeNamespace

func GetKubeNamespace() (string, error)

func GetOptionalEnv

func GetOptionalEnv(key, defaultValue string) string

func GetRequiredEnv

func GetRequiredEnv(key string) (string, error)

func GetValidRfc1035LabelName

func GetValidRfc1035LabelName(prefix, peerID string, chaincodeData *ChaincodeJSON, suffixLen int) string

GetValidRfc1035LabelName returns a valid RFC 1035 label name with the format <prefix>-<truncated_chaincode_label>-<chaincode_run_hash> and space for a suffix if required.

func WaitForChaincodeJob

func WaitForChaincodeJob(
	ctx context.Context,
	logger *log.CmdLogger,
	client cache.Getter,
	job *batchv1.Job,
	chaincodeID string,
) error

Types

type ChaincodeJSON

type ChaincodeJSON struct {
	ChaincodeID string `json:"chaincode_id"`
	PeerAddress string `json:"peer_address"`
	ClientCert  string `json:"client_cert"`
	ClientKey   string `json:"client_key"`
	RootCert    string `json:"root_cert"`
	MspID       string `json:"mspid"`
}

ChaincodeJSON represents the chaincode.json file that is supplied by Fabric in the RUN_METADATA_DIR.

func ReadChaincodeJSON

func ReadChaincodeJSON(logger *log.CmdLogger, dir string) (*ChaincodeJSON, error)

ReadChaincodeJSON reads and parses the chaincode.json file in the provided directory.

type ChaincodePackageID

type ChaincodePackageID struct {
	Label string
	Hash  string
}

func NewChaincodePackageID

func NewChaincodePackageID(chaincodeID string) *ChaincodePackageID

NewChaincodePackageID returns a ChaincodePackageID created from the provided string.

type ImageJSON

type ImageJSON struct {
	Name   string `json:"name"`
	Digest string `json:"digest"`
}

ImageJSON represents the image.json file in the k8s chaincode package.

func ReadImageJSON

func ReadImageJSON(logger *log.CmdLogger, dir string) (*ImageJSON, error)

ReadImageJSON reads and parses the image.json file in the provided directory.

type MetadataJSON

type MetadataJSON struct {
	Label string `json:"label"`
	Type  string `json:"type"`
}

MetadataJSON represents the metadata.json file in the k8s chaincode package.

func ReadMetadataJSON

func ReadMetadataJSON(logger *log.CmdLogger, dir string) (*MetadataJSON, error)

ReadMetadataJSON reads and parses the metadata.json file in the provided directory.