Reference

HLF Operator API#

Packages:

hlf.kungfusoftware.es/v1alpha1#

Resource Types:

FabricCA#

FabricCA is the Schema for the hlfs API

FieldDescription
apiVersionstringhlf.kungfusoftware.es/v1alpha1
kindstringFabricCA
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of themetadata field.
specFabricCASpec

affinityKubernetes core/v1.Affinity(Optional)
tolerations[]Kubernetes core/v1.Toleration(Optional)
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
nodeSelectorKubernetes core/v1.NodeSelector(Optional)
serviceMonitorServiceMonitor(Optional)
istioFabricIstio(Optional)
dbFabricCADatabase
hosts[]string

Hosts for the Fabric CA

serviceFabricCASpecService
imagestring
versionstring
debugbool
clrSizeLimitint
rootCAFabricCATLSConf
caFabricCAItemConf
tlsCAFabricCAItemConf
corsCors
resourcesKubernetes core/v1.ResourceRequirements
storageStorage
metricsFabricCAMetrics
env[]Kubernetes core/v1.EnvVar(Optional)

FabricChaincode#

FabricChaincode is the Schema for the hlfs API

FieldDescription
apiVersionstringhlf.kungfusoftware.es/v1alpha1
kindstringFabricChaincode
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of themetadata field.
specFabricChaincodeSpec

imagestring
imagePullPolicyKubernetes core/v1.PullPolicy
packageIdstring
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
affinityKubernetes core/v1.Affinity(Optional)
tolerations[]Kubernetes core/v1.Toleration(Optional)
resourcesKubernetes core/v1.ResourceRequirements(Optional)
credentialsTLS(Optional)
replicasint
env[]Kubernetes core/v1.EnvVar(Optional)

FabricExplorer#

FabricExplorer is the Schema for the hlfs API

FieldDescription
apiVersionstringhlf.kungfusoftware.es/v1alpha1
kindstringFabricExplorer
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of themetadata field.
specFabricExplorerSpec

resourcesKubernetes core/v1.ResourceRequirements

FabricFollowerChannel#

FabricFollowerChannel is the Schema for the hlfs API

FieldDescription
apiVersionstringhlf.kungfusoftware.es/v1alpha1
kindstringFabricFollowerChannel
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of themetadata field.
specFabricFollowerChannelSpec

namestring

Name of the channel

mspIdstring

MSP ID of the organization to join the channel

orderers[]FabricFollowerChannelOrderer

Orderers to fetch the configuration block from

peersToJoin[]FabricFollowerChannelPeer

Peers to join the channel

externalPeersToJoin[]FabricFollowerChannelExternalPeer

Peers to join the channel

anchorPeers[]FabricFollowerChannelAnchorPeer

Anchor peers defined for the current organization

hlfIdentityHLFIdentity

Identity to use to interact with the peers and the orderers

FabricMainChannel#

FabricMainChannel is the Schema for the hlfs API

FieldDescription
apiVersionstringhlf.kungfusoftware.es/v1alpha1
kindstringFabricMainChannel
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of themetadata field.
specFabricMainChannelSpec

namestring

Name of the channel

identitiesmap[string]github.com/kfsoftware/hlf-operator/api/hlf.kungfusoftware.es/v1alpha1.FabricMainChannelIdentity

HLF Identities to be used to create and manage the channel

adminPeerOrganizations[]FabricMainChannelAdminPeerOrganizationSpec

Organizations that manage the application configuration of the channel

peerOrganizations[]FabricMainChannelPeerOrganization

Peer organizations that are external to the Kubernetes cluster

externalPeerOrganizations[]FabricMainChannelExternalPeerOrganization

External peer organizations that are inside the kubernetes cluster

channelConfigFabricMainChannelConfig

Configuration about the channel

adminOrdererOrganizations[]FabricMainChannelAdminOrdererOrganizationSpec

Organizations that manage the orderer configuration of the channel

ordererOrganizations[]FabricMainChannelOrdererOrganization

External orderer organizations that are inside the kubernetes cluster

externalOrdererOrganizations[]FabricMainChannelExternalOrdererOrganization

Orderer organizations that are external to the Kubernetes cluster

orderers[]FabricMainChannelConsenter

Consenters are the orderer nodes that are part of the channel consensus

FabricNetworkConfig#

FabricNetworkConfig is the Schema for the hlfs API

FieldDescription
apiVersionstringhlf.kungfusoftware.es/v1alpha1
kindstringFabricNetworkConfig
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of themetadata field.
specFabricNetworkConfigSpec

organizationstring
internalbool
organizations[]string
secretNamestring

FabricOperationsConsole#

FabricOperationsConsole is the Schema for the hlfs API

FieldDescription
apiVersionstringhlf.kungfusoftware.es/v1alpha1
kindstringFabricOperationsConsole
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of themetadata field.
specFabricOperationsConsoleSpec

authFabricOperationsConsoleAuth
resourcesKubernetes core/v1.ResourceRequirements(Optional)
imagestring
tagstring
imagePullPolicyKubernetes core/v1.PullPolicy
tolerations[]Kubernetes core/v1.Toleration(Optional)
replicasint
couchDBFabricOperationsConsoleCouchDB
env[]Kubernetes core/v1.EnvVar(Optional)
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
affinityKubernetes core/v1.Affinity(Optional)
portint
configstring(Optional)
ingressIngress
hostUrlstring

FabricOperatorAPI#

FabricOperatorAPI is the Schema for the hlfs API

FieldDescription
apiVersionstringhlf.kungfusoftware.es/v1alpha1
kindstringFabricOperatorAPI
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of themetadata field.
specFabricOperatorAPISpec

imagestring
tagstring
imagePullPolicyKubernetes core/v1.PullPolicy
istioFabricIstio
ingressIngress
replicasint
authFabricOperatorAPIAuth(Optional)
hlfConfigFabricOperatorAPIHLFConfig
tolerations[]Kubernetes core/v1.Toleration(Optional)
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
env[]Kubernetes core/v1.EnvVar(Optional)
affinityKubernetes core/v1.Affinity(Optional)
resourcesKubernetes core/v1.ResourceRequirements(Optional)

FabricOperatorUI#

FabricOperatorUI is the Schema for the hlfs API

FieldDescription
apiVersionstringhlf.kungfusoftware.es/v1alpha1
kindstringFabricOperatorUI
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of themetadata field.
specFabricOperatorUISpec

imagestring
tagstring
imagePullPolicyKubernetes core/v1.PullPolicy
logoUrlstring
authFabricOperatorUIAuth(Optional)
tolerations[]Kubernetes core/v1.Toleration(Optional)
replicasint
ingressIngress
apiUrlstring
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
env[]Kubernetes core/v1.EnvVar(Optional)
affinityKubernetes core/v1.Affinity(Optional)
resourcesKubernetes core/v1.ResourceRequirements(Optional)

FabricOrdererNode#

FabricOrdererNode is the Schema for the hlfs API

FieldDescription
apiVersionstringhlf.kungfusoftware.es/v1alpha1
kindstringFabricOrdererNode
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of themetadata field.
specFabricOrdererNodeSpec

tolerations[]Kubernetes core/v1.Toleration(Optional)
grpcProxyGRPCProxy(Optional)
affinityKubernetes core/v1.Affinity(Optional)
updateCertificateTimeKubernetes meta/v1.Time(Optional)
serviceMonitorServiceMonitor(Optional)
hostAliases[]Kubernetes core/v1.HostAlias(Optional)
nodeSelectorKubernetes core/v1.NodeSelector(Optional)
resourcesKubernetes core/v1.ResourceRequirements
replicasint
imagestring
tagstring
pullPolicyKubernetes core/v1.PullPolicy
mspIDstring
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
genesisstring
bootstrapMethodBootstrapMethod
channelParticipationEnabledbool
storageStorage
serviceOrdererNodeService
secretSecret(Optional)
istioFabricIstio(Optional)
adminIstioFabricIstio(Optional)
env[]Kubernetes core/v1.EnvVar(Optional)

FabricOrderingService#

FabricOrderingService is the Schema for the hlfs API

FieldDescription
apiVersionstringhlf.kungfusoftware.es/v1alpha1
kindstringFabricOrderingService
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of themetadata field.
specFabricOrderingServiceSpec

imagestring
tagstring
mspIDstring
enrollmentOrdererEnrollment
nodes[]OrdererNode
serviceOrdererService
storageStorage
systemChannelOrdererSystemChannel

FabricPeer#

FabricPeer is the Schema for the hlfs API

FieldDescription
apiVersionstringhlf.kungfusoftware.es/v1alpha1
kindstringFabricPeer
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of themetadata field.
specFabricPeerSpec

updateCertificateTimeKubernetes meta/v1.Time(Optional)
affinityKubernetes core/v1.Affinity(Optional)
serviceMonitorServiceMonitor(Optional)
hostAliases[]Kubernetes core/v1.HostAlias(Optional)
nodeSelectorKubernetes core/v1.NodeSelector(Optional)
couchDBexporterFabricPeerCouchdbExporter(Optional)
grpcProxyGRPCProxy(Optional)
replicasint
dockerSocketPathstring
imagestring
externalBuilders[]ExternalBuilder(Optional)
istioFabricIstio(Optional)
gossipFabricPeerSpecGossip
externalEndpointstring
tagstring
imagePullPolicyKubernetes core/v1.PullPolicy
external_chaincode_builderbool
couchdbFabricPeerCouchDB
fsServerFabricFSServer(Optional)
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
mspIDstring
secretSecret
servicePeerService
stateDbStateDB
storageFabricPeerStorage
discoveryFabricPeerDiscovery
loggingFabricPeerLogging
resourcesFabricPeerResources
hosts[]string
tolerations[]Kubernetes core/v1.Toleration(Optional)
env[]Kubernetes core/v1.EnvVar(Optional)

ApplicationCapabilities#

(Appears on:ChannelConfig)

FieldDescription
V2_0bool

BootstrapMethod (string alias)#

(Appears on:FabricOrdererNodeSpec)

CA#

FieldDescription
hoststring
certstring
userstring
passwordstring

CARef#

FieldDescription
caNamestring
caNamespacestring

FabricCA Namespace of the organization

Catls#

(Appears on:Component,TLS)

FieldDescription
cacertstring

ChannelCapabilities#

(Appears on:ChannelConfig)

FieldDescription
V2_0bool

ChannelConfig#

(Appears on:OrdererSystemChannel)

FieldDescription
batchTimeoutstring
maxMessageCountint
absoluteMaxBytesint
preferredMaxBytesint
ordererCapabilitiesOrdererCapabilities
applicationCapabilitiesApplicationCapabilities
channelCapabilitiesChannelCapabilities
snapshotIntervalSizeint
tickIntervalstring
electionTickint
heartbeatTickint
maxInflightBlocksint

Component#

(Appears on:Enrollment,OrdererEnrollment)

FieldDescription
cahoststring
canamestring
caportint
catlsCatls
enrollidstring
enrollsecretstring

Condition#

FieldDescription
typeConditionType
reasonConditionReason
messagestring
lastTransitionTimeKubernetes meta/v1.Time

ConditionReason (string alias)#

(Appears on:Condition)

ConditionReason is intended to be a one-word, CamelCase representation of the category of cause of the current status. It is intended to be used in concise output, such as one-line kubectl get output, and in summarizing occurrences of causes.

ConditionType (string alias)#

(Appears on:Condition)

ConditionType is the type of the condition and is typically a CamelCased word or short phrase.

Condition types should indicate state in the “abnormal-true” polarity. For example, if the condition indicates when a policy is invalid, the “is valid” case is probably the norm, so the condition should be called “Invalid”.

Cors#

(Appears on:FabricCASpec)

FieldDescription
enabledbool
origins[]string

Csr#

(Appears on:OrdererNodeEnrollmentTLS,TLS)

FieldDescription
hosts[]string(Optional)
cnstring(Optional)

DeploymentStatus (string alias)#

(Appears on:FabricCAStatus,FabricChaincodeStatus,FabricExplorerStatus,FabricFollowerChannelStatus,FabricMainChannelStatus,FabricNetworkConfigStatus,FabricOperationsConsoleStatus,FabricOperatorAPIStatus,FabricOperatorUIStatus,FabricOrdererNodeStatus,FabricOrderingServiceStatus,FabricPeerStatus)

Enrollment#

(Appears on:Secret)

FieldDescription
componentComponent
tlsTLS

ExternalBuilder#

(Appears on:FabricPeerSpec)

FieldDescription
namestring
pathstring
propagateEnvironment[]string(Optional)

FabricCAAffiliation#

(Appears on:FabricCAItemConf)

FieldDescription
namestring
departments[]string

FabricCABCCSP#

(Appears on:FabricCAItemConf)

FieldDescription
defaultstring
swFabricCABCCSPSW

FabricCABCCSPSW#

(Appears on:FabricCABCCSP)

FieldDescription
hashstring
securitystring

FabricCACFG#

(Appears on:FabricCAItemConf)

FieldDescription
identitiesFabricCACFGIdentities
affiliationsFabricCACFGAffilitions

FabricCACFGAffilitions#

(Appears on:FabricCACFG)

FieldDescription
allowRemovebool

FabricCACFGIdentities#

(Appears on:FabricCACFG)

FieldDescription
allowRemovebool

FabricCACRL#

(Appears on:FabricCAItemConf)

FieldDescription
expirystring

FabricCACSR#

(Appears on:FabricCAItemConf)

FieldDescription
cnstring
hosts[]string
names[]FabricCANames
caFabricCACSRCA

FabricCACSRCA#

(Appears on:FabricCACSR)

FieldDescription
expirystring
pathLengthint

FabricCAClientAuth#

(Appears on:FabricTLSCACrypto)

FieldDescription
typestring

NoClientCert, RequestClientCert, RequireAnyClientCert, VerifyClientCertIfGiven and RequireAndVerifyClientCert.

cert_file[]string

FabricCACrypto#

(Appears on:FabricCAItemConf)

FieldDescription
keystring
certstring
chainstring

FabricCADatabase#

(Appears on:FabricCASpec)

FieldDescription
typestring
datasourcestring

FabricCAIdentity#

(Appears on:FabricCARegistry)

FieldDescription
namestring
passstring
typestring
affiliationstring
attrsFabricCAIdentityAttrs

FabricCAIdentityAttrs#

(Appears on:FabricCAIdentity)

FieldDescription
hf.Registrar.Rolesstring
hf.Registrar.DelegateRolesstring
hf.Registrar.Attributesstring
hf.Revokerbool
hf.IntermediateCAbool
hf.GenCRLbool
hf.AffiliationMgrbool

FabricCAIntermediate#

(Appears on:FabricCAItemConf)

FieldDescription
parentServerFabricCAIntermediateParentServer

FabricCAIntermediateEnrollment#

FieldDescription
hostsstring
profilestring
labelstring

FabricCAIntermediateParentServer#

(Appears on:FabricCAIntermediate)

FieldDescription
urlstring
caNamestring

FabricCA Name of the organization

FabricCAIntermediateTLS#

FieldDescription
certFiles[]string
clientFabricCAIntermediateTLSClient

FabricCAIntermediateTLSClient#

(Appears on:FabricCAIntermediateTLS)

FieldDescription
certFilestring
keyFilestring

FabricCAItemConf#

(Appears on:FabricCASpec)

FieldDescription
namestring
cfgFabricCACFG
subjectFabricCASubject
csrFabricCACSR
signingFabricCASigning(Optional)
crlFabricCACRL
registryFabricCARegistry
intermediateFabricCAIntermediate
bccspFabricCABCCSP
affiliations[]FabricCAAffiliation(Optional)
caFabricCACrypto(Optional)
tlsCaFabricTLSCACrypto(Optional)

FabricCAMetrics#

(Appears on:FabricCASpec)

FieldDescription
providerstring
statsdFabricCAMetricsStatsd(Optional)

FabricCAMetricsStatsd#

(Appears on:FabricCAMetrics)

FieldDescription
networkstring
addressstring(Optional)
writeIntervalstring(Optional)
prefixstring(Optional)

FabricCANames#

(Appears on:FabricCACSR)

FieldDescription
Cstring
STstring
Ostring
Lstring
OUstring

FabricCARegistry#

(Appears on:FabricCAItemConf)

FieldDescription
max_enrollmentsint
identities[]FabricCAIdentity

FabricCASigning#

(Appears on:FabricCAItemConf)

FieldDescription
defaultFabricCASigningDefault
profilesFabricCASigningProfiles

FabricCASigningDefault#

(Appears on:FabricCASigning)

FieldDescription
expirystring
usage[]string

FabricCASigningProfiles#

(Appears on:FabricCASigning)

FieldDescription
caFabricCASigningSignProfile
tlsFabricCASigningTLSProfile

FabricCASigningSignProfile#

(Appears on:FabricCASigningProfiles)

FieldDescription
usage[]string
expirystring
caconstraintFabricCASigningSignProfileConstraint

FabricCASigningSignProfileConstraint#

(Appears on:FabricCASigningSignProfile)

FieldDescription
isCAbool
maxPathLenint

FabricCASigningTLSProfile#

(Appears on:FabricCASigningProfiles)

FieldDescription
usage[]string
expirystring

FabricCASpec#

(Appears on:FabricCA)

FabricCASpec defines the desired state of FabricCA

FieldDescription
affinityKubernetes core/v1.Affinity(Optional)
tolerations[]Kubernetes core/v1.Toleration(Optional)
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
nodeSelectorKubernetes core/v1.NodeSelector(Optional)
serviceMonitorServiceMonitor(Optional)
istioFabricIstio(Optional)
dbFabricCADatabase
hosts[]string

Hosts for the Fabric CA

serviceFabricCASpecService
imagestring
versionstring
debugbool
clrSizeLimitint
rootCAFabricCATLSConf
caFabricCAItemConf
tlsCAFabricCAItemConf
corsCors
resourcesKubernetes core/v1.ResourceRequirements
storageStorage
metricsFabricCAMetrics
env[]Kubernetes core/v1.EnvVar(Optional)

FabricCASpecService#

(Appears on:FabricCASpec)

FieldDescription
typeKubernetes core/v1.ServiceType

FabricCAStatus#

(Appears on:FabricCA)

FabricCAStatus defines the observed state of FabricCA

FieldDescription
conditionsgithub.com/kfsoftware/hlf-operator/pkg/status.Conditions
messagestring
nodePortint(Optional)
tls_certstring

TLS Certificate to connect to the FabricCA

ca_certstring

Root certificate for Sign certificates generated by FabricCA

tlsca_certstring

Root certificate for TLS certificates generated by FabricCA

FabricCASubject#

(Appears on:FabricCAItemConf,FabricCATLSConf)

FieldDescription
cnstring
Cstring
STstring
Ostring
Lstring
OUstring

FabricCATLSConf#

(Appears on:FabricCASpec)

FieldDescription
subjectFabricCASubject

FabricChaincodeSpec#

(Appears on:FabricChaincode)

FabricChaincodeSpec defines the desired state of FabricChaincode

FieldDescription
imagestring
imagePullPolicyKubernetes core/v1.PullPolicy
packageIdstring
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
affinityKubernetes core/v1.Affinity(Optional)
tolerations[]Kubernetes core/v1.Toleration(Optional)
resourcesKubernetes core/v1.ResourceRequirements(Optional)
credentialsTLS(Optional)
replicasint
env[]Kubernetes core/v1.EnvVar(Optional)

FabricChaincodeStatus#

(Appears on:FabricChaincode)

FabricChaincodeStatus defines the observed state of FabricChaincode

FieldDescription
conditionsgithub.com/kfsoftware/hlf-operator/pkg/status.Conditions
messagestring

FabricExplorerSpec#

(Appears on:FabricExplorer)

FabricExplorerSpec defines the desired state of FabricExplorer

FieldDescription
resourcesKubernetes core/v1.ResourceRequirements

FabricExplorerStatus#

(Appears on:FabricExplorer)

FabricExplorerStatus defines the observed state of FabricExplorer

FieldDescription
conditionsgithub.com/kfsoftware/hlf-operator/pkg/status.Conditions
messagestring

FabricFSServer#

(Appears on:FabricPeerSpec)

FieldDescription
imagestring
tagstring
pullPolicyKubernetes core/v1.PullPolicy

FabricFollowerChannelAnchorPeer#

(Appears on:FabricFollowerChannelSpec)

FieldDescription
hoststring

Host of the anchor peer

portint

Port of the anchor peer

FabricFollowerChannelExternalPeer#

(Appears on:FabricFollowerChannelSpec)

FieldDescription
urlstring

FabricPeer URL of the peer

tlsCACertstring

FabricPeer TLS CA certificate of the peer

FabricFollowerChannelOrderer#

(Appears on:FabricFollowerChannelSpec)

FieldDescription
urlstring

URL of the orderer, e.g.: “grpcs://xxxxx:443”

certificatestring

TLS Certificate of the orderer node

FabricFollowerChannelPeer#

(Appears on:FabricFollowerChannelSpec)

FieldDescription
namestring

FabricPeer Name of the peer inside the kubernetes cluster

namespacestring

FabricPeer Namespace of the peer inside the kubernetes cluster

FabricFollowerChannelSpec#

(Appears on:FabricFollowerChannel)

FabricFollowerChannelSpec defines the desired state of FabricFollowerChannel

FieldDescription
namestring

Name of the channel

mspIdstring

MSP ID of the organization to join the channel

orderers[]FabricFollowerChannelOrderer

Orderers to fetch the configuration block from

peersToJoin[]FabricFollowerChannelPeer

Peers to join the channel

externalPeersToJoin[]FabricFollowerChannelExternalPeer

Peers to join the channel

anchorPeers[]FabricFollowerChannelAnchorPeer

Anchor peers defined for the current organization

hlfIdentityHLFIdentity

Identity to use to interact with the peers and the orderers

FabricFollowerChannelStatus#

(Appears on:FabricFollowerChannel)

FabricFollowerChannelStatus defines the observed state of FabricFollowerChannel

FieldDescription
conditionsgithub.com/kfsoftware/hlf-operator/pkg/status.Conditions
messagestring

FabricIstio#

(Appears on:FabricCASpec,FabricOperatorAPISpec,FabricOrdererNodeSpec,FabricPeerSpec,GRPCProxy)

FieldDescription
portint(Optional)
hosts[]string(Optional)
ingressGatewaystring

FabricMainChannelAdminOrdererOrganizationSpec#

(Appears on:FabricMainChannelSpec)

FieldDescription
mspIDstring

MSP ID of the organization

FabricMainChannelAdminPeerOrganizationSpec#

(Appears on:FabricMainChannelSpec)

FieldDescription
mspIDstring

MSP ID of the organization

FabricMainChannelAnchorPeer#

FieldDescription
hoststring

Host of the peer

portint

Port of the peer

FabricMainChannelApplicationConfig#

(Appears on:FabricMainChannelConfig)

FieldDescription
capabilities[]string

Capabilities of the application channel configuration

policiesmap[string]github.com/kfsoftware/hlf-operator/api/hlf.kungfusoftware.es/v1alpha1.FabricMainChannelPoliciesConfig(Optional)

Policies of the application channel configuration

aclsmap[string]string(Optional)

ACLs of the application channel configuration

FabricMainChannelConfig#

(Appears on:FabricMainChannelSpec)

FieldDescription
applicationFabricMainChannelApplicationConfig(Optional)

Application configuration of the channel

ordererFabricMainChannelOrdererConfig(Optional)

Orderer configuration of the channel

capabilities[]string

Capabilities for the channel

policiesmap[string]github.com/kfsoftware/hlf-operator/api/hlf.kungfusoftware.es/v1alpha1.FabricMainChannelPoliciesConfig(Optional)

Policies for the channel

FabricMainChannelConsensusState (string alias)#

(Appears on:FabricMainChannelOrdererConfig)

FabricMainChannelConsenter#

(Appears on:FabricMainChannelSpec)

FieldDescription
hoststring

Orderer host of the consenter

portint

Orderer port of the consenter

tlsCertstring

TLS Certificate of the orderer node

FabricMainChannelEtcdRaft#

(Appears on:FabricMainChannelOrdererConfig)

FieldDescription
optionsFabricMainChannelEtcdRaftOptions(Optional)

FabricMainChannelEtcdRaftOptions#

(Appears on:FabricMainChannelEtcdRaft)

FieldDescription
tickIntervalstring
electionTickuint32
heartbeatTickuint32

HeartbeatTick is the number of ticks that must pass between heartbeats

maxInflightBlocksuint32

MaxInflightBlocks is the maximum number of in-flight blocks that may be sent to followers at any given time.

snapshotIntervalSizeuint32

Maximum size of each raft snapshot file.

FabricMainChannelExternalOrdererNode#

(Appears on:FabricMainChannelOrdererOrganization)

FieldDescription
hoststring

Admin host of the orderer node

portint

Admin port of the orderer node

FabricMainChannelExternalOrdererOrganization#

(Appears on:FabricMainChannelSpec)

FieldDescription
mspIDstring

MSP ID of the organization

tlsRootCertstring

TLS Root certificate authority of the orderer organization

signRootCertstring

Root certificate authority for signing

ordererEndpoints[]string

Orderer endpoints for the organization in the channel configuration

FabricMainChannelExternalPeerOrganization#

(Appears on:FabricMainChannelSpec)

FieldDescription
mspIDstring

MSP ID of the organization

tlsRootCertstring

TLS Root certificate authority of the orderer organization

signRootCertstring

Root certificate authority for signing

FabricMainChannelIdentity#

(Appears on:FabricMainChannelSpec)

FieldDescription
secretNamespacestring

Secret namespace

secretNamestring

Secret name

secretKeystring

Key inside the secret that holds the private key and certificate to interact with the network

FabricMainChannelOrdererBatchSize#

(Appears on:FabricMainChannelOrdererConfig)

FieldDescription
maxMessageCountint

The number of transactions that can fit in a block.

absoluteMaxBytesint

The absolute maximum size of a block, including all metadata.

preferredMaxBytesint

The preferred maximum size of a block, including all metadata.

FabricMainChannelOrdererConfig#

(Appears on:FabricMainChannelConfig)

FieldDescription
ordererTypestring

OrdererType of the consensus, default “etcdraft”

capabilities[]string

Capabilities of the channel

policiesmap[string]github.com/kfsoftware/hlf-operator/api/hlf.kungfusoftware.es/v1alpha1.FabricMainChannelPoliciesConfig(Optional)

Policies of the orderer section of the channel

batchTimeoutstring

Interval of the ordering service to create a block and send to the peers

batchSizeFabricMainChannelOrdererBatchSize(Optional)
stateFabricMainChannelConsensusState

State about the channel, can only be STATE_NORMAL or STATE_MAINTENANCE.

etcdRaftFabricMainChannelEtcdRaft(Optional)

FabricMainChannelOrdererNode#

(Appears on:FabricMainChannelOrdererOrganization)

FieldDescription
namestring

Name of the orderer node

namespacestring

Kubernetes namespace of the orderer node

FabricMainChannelOrdererOrganization#

(Appears on:FabricMainChannelSpec)

FieldDescription
mspIDstring

MSP ID of the organization

caNamestring(Optional)

FabricCA Name of the organization

caNamespacestring(Optional)

FabricCA Namespace of the organization

tlsCACertstring(Optional)

TLS Root certificate authority of the orderer organization

signCACertstring(Optional)

Root certificate authority for signing

ordererEndpoints[]string

Orderer endpoints for the organization in the channel configuration

orderersToJoin[]FabricMainChannelOrdererNode

Orderer nodes within the kubernetes cluster to be added to the channel

externalOrderersToJoin[]FabricMainChannelExternalOrdererNode

External orderers to be added to the channel

FabricMainChannelPeerOrganization#

(Appears on:FabricMainChannelSpec)

FieldDescription
mspIDstring

MSP ID of the organization

caNamestring

FabricCA Name of the organization

caNamespacestring

FabricCA Namespace of the organization

FabricMainChannelPoliciesConfig#

FieldDescription
typestring

Type of policy, can only be ImplicitMeta or Signature.

rulestring

Rule of policy

modPolicystring

FabricMainChannelSpec#

(Appears on:FabricMainChannel)

FabricMainChannelSpec defines the desired state of FabricMainChannel

FieldDescription
namestring

Name of the channel

identitiesmap[string]github.com/kfsoftware/hlf-operator/api/hlf.kungfusoftware.es/v1alpha1.FabricMainChannelIdentity

HLF Identities to be used to create and manage the channel

adminPeerOrganizations[]FabricMainChannelAdminPeerOrganizationSpec

Organizations that manage the application configuration of the channel

peerOrganizations[]FabricMainChannelPeerOrganization

Peer organizations that are external to the Kubernetes cluster

externalPeerOrganizations[]FabricMainChannelExternalPeerOrganization

External peer organizations that are inside the kubernetes cluster

channelConfigFabricMainChannelConfig

Configuration about the channel

adminOrdererOrganizations[]FabricMainChannelAdminOrdererOrganizationSpec

Organizations that manage the orderer configuration of the channel

ordererOrganizations[]FabricMainChannelOrdererOrganization

External orderer organizations that are inside the kubernetes cluster

externalOrdererOrganizations[]FabricMainChannelExternalOrdererOrganization

Orderer organizations that are external to the Kubernetes cluster

orderers[]FabricMainChannelConsenter

Consenters are the orderer nodes that are part of the channel consensus

FabricMainChannelStatus#

(Appears on:FabricMainChannel)

FabricMainChannelStatus defines the observed state of FabricMainChannel

FieldDescription
conditionsgithub.com/kfsoftware/hlf-operator/pkg/status.Conditions
messagestring

FabricNetworkConfigSpec#

(Appears on:FabricNetworkConfig)

FabricNetworkConfigSpec defines the desired state of FabricNetworkConfig

FieldDescription
organizationstring
internalbool
organizations[]string
secretNamestring

FabricNetworkConfigStatus#

(Appears on:FabricNetworkConfig)

FabricNetworkConfigStatus defines the observed state of FabricNetworkConfig

FieldDescription
conditionsgithub.com/kfsoftware/hlf-operator/pkg/status.Conditions
messagestring

FabricOperationsConsoleAuth#

(Appears on:FabricOperationsConsoleSpec)

FieldDescription
schemestring
usernamestring
passwordstring

FabricOperationsConsoleCouchDB#

(Appears on:FabricOperationsConsoleSpec)

FabricOperationsConsoleSpec defines the desired state of FabricOperationsConsole

FieldDescription
imagestring
tagstring
usernamestring
passwordstring
storageStorage
resourcesKubernetes core/v1.ResourceRequirements(Optional)
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
affinityKubernetes core/v1.Affinity(Optional)
tolerations[]Kubernetes core/v1.Toleration(Optional)
imagePullPolicyKubernetes core/v1.PullPolicy

FabricOperationsConsoleSpec#

(Appears on:FabricOperationsConsole)

FabricOperationsConsoleSpec defines the desired state of FabricOperationsConsole

FieldDescription
authFabricOperationsConsoleAuth
resourcesKubernetes core/v1.ResourceRequirements(Optional)
imagestring
tagstring
imagePullPolicyKubernetes core/v1.PullPolicy
tolerations[]Kubernetes core/v1.Toleration(Optional)
replicasint
couchDBFabricOperationsConsoleCouchDB
env[]Kubernetes core/v1.EnvVar(Optional)
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
affinityKubernetes core/v1.Affinity(Optional)
portint
configstring(Optional)
ingressIngress
hostUrlstring

FabricOperationsConsoleStatus#

(Appears on:FabricOperationsConsole)

FabricOperationsConsoleStatus defines the observed state of FabricOperationsConsole

FieldDescription
conditionsgithub.com/kfsoftware/hlf-operator/pkg/status.Conditions
messagestring

FabricOperatorAPIAuth#

(Appears on:FabricOperatorAPISpec)

FieldDescription
oidcJWKSstring
oidcIssuerstring

FabricOperatorAPIHLFConfig#

(Appears on:FabricOperatorAPISpec)

FieldDescription
mspIDstring
userstring
networkConfigFabricOperatorAPINetworkConfig

FabricOperatorAPINetworkConfig#

(Appears on:FabricOperatorAPIHLFConfig)

FieldDescription
secretNamestring
keystring

FabricOperatorAPISpec#

(Appears on:FabricOperatorAPI)

FabricOperatorAPISpec defines the desired state of FabricOperatorAPI

FieldDescription
imagestring
tagstring
imagePullPolicyKubernetes core/v1.PullPolicy
istioFabricIstio
ingressIngress
replicasint
authFabricOperatorAPIAuth(Optional)
hlfConfigFabricOperatorAPIHLFConfig
tolerations[]Kubernetes core/v1.Toleration(Optional)
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
env[]Kubernetes core/v1.EnvVar(Optional)
affinityKubernetes core/v1.Affinity(Optional)
resourcesKubernetes core/v1.ResourceRequirements(Optional)

FabricOperatorAPIStatus#

(Appears on:FabricOperatorAPI)

FabricOperatorAPIStatus defines the observed state of FabricOperatorAPI

FieldDescription
conditionsgithub.com/kfsoftware/hlf-operator/pkg/status.Conditions
messagestring

FabricOperatorUIAuth#

(Appears on:FabricOperatorUISpec)

FieldDescription
oidcAuthoritystring
oidcClientIdstring
oidcScopestring

FabricOperatorUISpec#

(Appears on:FabricOperatorUI)

FabricOperatorUISpec defines the desired state of FabricOperatorUI

FieldDescription
imagestring
tagstring
imagePullPolicyKubernetes core/v1.PullPolicy
logoUrlstring
authFabricOperatorUIAuth(Optional)
tolerations[]Kubernetes core/v1.Toleration(Optional)
replicasint
ingressIngress
apiUrlstring
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
env[]Kubernetes core/v1.EnvVar(Optional)
affinityKubernetes core/v1.Affinity(Optional)
resourcesKubernetes core/v1.ResourceRequirements(Optional)

FabricOperatorUIStatus#

(Appears on:FabricOperatorUI)

FabricOperatorUIStatus defines the observed state of FabricOperatorUI

FieldDescription
conditionsgithub.com/kfsoftware/hlf-operator/pkg/status.Conditions
messagestring

FabricOrdererNodeSpec#

(Appears on:FabricOrdererNode)

FabricOrdererNodeSpec defines the desired state of FabricOrdererNode

FieldDescription
tolerations[]Kubernetes core/v1.Toleration(Optional)
grpcProxyGRPCProxy(Optional)
affinityKubernetes core/v1.Affinity(Optional)
updateCertificateTimeKubernetes meta/v1.Time(Optional)
serviceMonitorServiceMonitor(Optional)
hostAliases[]Kubernetes core/v1.HostAlias(Optional)
nodeSelectorKubernetes core/v1.NodeSelector(Optional)
resourcesKubernetes core/v1.ResourceRequirements
replicasint
imagestring
tagstring
pullPolicyKubernetes core/v1.PullPolicy
mspIDstring
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
genesisstring
bootstrapMethodBootstrapMethod
channelParticipationEnabledbool
storageStorage
serviceOrdererNodeService
secretSecret(Optional)
istioFabricIstio(Optional)
adminIstioFabricIstio(Optional)
env[]Kubernetes core/v1.EnvVar(Optional)

FabricOrdererNodeStatus#

(Appears on:FabricOrdererNode)

FabricOrdererNodeStatus defines the observed state of FabricOrdererNode

FieldDescription
conditionsgithub.com/kfsoftware/hlf-operator/pkg/status.Conditions
lastCertificateUpdateKubernetes meta/v1.Time(Optional)
signCertstring(Optional)
tlsCertstring(Optional)
signCaCertstring(Optional)
tlsCaCertstring(Optional)
tlsAdminCertstring(Optional)
operationsPortint(Optional)
adminPortint(Optional)
portint(Optional)
messagestring(Optional)

FabricOrderingServiceSpec#

(Appears on:FabricOrderingService)

FabricOrderingServiceSpec defines the desired state of FabricOrderingService

FieldDescription
imagestring
tagstring
mspIDstring
enrollmentOrdererEnrollment
nodes[]OrdererNode
serviceOrdererService
storageStorage
systemChannelOrdererSystemChannel

FabricOrderingServiceStatus#

(Appears on:FabricOrderingService)

FabricOrderingServiceStatus defines the observed state of FabricOrderingService

FieldDescription
conditionsgithub.com/kfsoftware/hlf-operator/pkg/status.Conditions

FabricPeerCouchDB#

(Appears on:FabricPeerSpec)

FieldDescription
userstring
passwordstring
imagestring
tagstring
pullPolicyKubernetes core/v1.PullPolicy
externalCouchDBFabricPeerExternalCouchDB(Optional)

FabricPeerCouchdbExporter#

(Appears on:FabricPeerSpec)

FieldDescription
enabledbool
imagestring
tagstring
imagePullPolicyKubernetes core/v1.PullPolicy

FabricPeerDiscovery#

(Appears on:FabricPeerSpec)

FieldDescription
periodstring
touchPeriodstring

FabricPeerExternalCouchDB#

(Appears on:FabricPeerCouchDB)

FieldDescription
enabledbool
hoststring
portint

FabricPeerLogging#

(Appears on:FabricPeerSpec)

FieldDescription
levelstring
peerstring
cauthdslstring
gossipstring
grpcstring
ledgerstring
mspstring
policiesstring

FabricPeerResources#

(Appears on:FabricPeerSpec)

FieldDescription
peerKubernetes core/v1.ResourceRequirements
couchdbKubernetes core/v1.ResourceRequirements
chaincodeKubernetes core/v1.ResourceRequirements
couchdbExporterKubernetes core/v1.ResourceRequirements(Optional)
proxyKubernetes core/v1.ResourceRequirements(Optional)

FabricPeerSpec#

(Appears on:FabricPeer)

FabricPeerSpec defines the desired state of FabricPeer

FieldDescription
updateCertificateTimeKubernetes meta/v1.Time(Optional)
affinityKubernetes core/v1.Affinity(Optional)
serviceMonitorServiceMonitor(Optional)
hostAliases[]Kubernetes core/v1.HostAlias(Optional)
nodeSelectorKubernetes core/v1.NodeSelector(Optional)
couchDBexporterFabricPeerCouchdbExporter(Optional)
grpcProxyGRPCProxy(Optional)
replicasint
dockerSocketPathstring
imagestring
externalBuilders[]ExternalBuilder(Optional)
istioFabricIstio(Optional)
gossipFabricPeerSpecGossip
externalEndpointstring
tagstring
imagePullPolicyKubernetes core/v1.PullPolicy
external_chaincode_builderbool
couchdbFabricPeerCouchDB
fsServerFabricFSServer(Optional)
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)
mspIDstring
secretSecret
servicePeerService
stateDbStateDB
storageFabricPeerStorage
discoveryFabricPeerDiscovery
loggingFabricPeerLogging
resourcesFabricPeerResources
hosts[]string
tolerations[]Kubernetes core/v1.Toleration(Optional)
env[]Kubernetes core/v1.EnvVar(Optional)

FabricPeerSpecGossip#

(Appears on:FabricPeerSpec)

FieldDescription
externalEndpointstring
bootstrapstring
endpointstring
useLeaderElectionbool
orgLeaderbool

FabricPeerStatus#

(Appears on:FabricPeer)

FabricPeerStatus defines the observed state of FabricPeer

FieldDescription
conditionsgithub.com/kfsoftware/hlf-operator/pkg/status.Conditions
messagestring
lastCertificateUpdateKubernetes meta/v1.Time(Optional)
signCertstring(Optional)
tlsCertstring(Optional)
tlsCaCertstring(Optional)
signCaCertstring(Optional)
portint(Optional)

FabricPeerStorage#

(Appears on:FabricPeerSpec)

FieldDescription
couchdbStorage
peerStorage
chaincodeStorage

FabricTLSCACrypto#

(Appears on:FabricCAItemConf)

FieldDescription
keystring
certstring
clientAuthFabricCAClientAuth

GRPCProxy#

(Appears on:FabricOrdererNodeSpec,FabricPeerSpec)

FieldDescription
enabledbool
imagestring
tagstring
istioFabricIstio
imagePullPolicyKubernetes core/v1.PullPolicy
resourcesKubernetes core/v1.ResourceRequirements
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)

HLFIdentity#

(Appears on:FabricFollowerChannelSpec)

FieldDescription
secretNamestring

Secret name

secretNamespacestring

Secret namespace

secretKeystring

Key inside the secret that holds the private key and certificate to interact with the network

Ingress#

(Appears on:FabricOperationsConsoleSpec,FabricOperatorAPISpec,FabricOperatorUISpec)

FieldDescription
enabledbool
classNamestring
annotationsmap[string]string
tls[]Kubernetes networking/v1beta1.IngressTLS
hosts[]IngressHost

IngressHost#

(Appears on:Ingress)

FieldDescription
hoststring
paths[]IngressPath

IngressPath#

(Appears on:IngressHost)

FieldDescription
pathstring
pathTypestring

MetricsProvider (string alias)#

OrdererCapabilities#

(Appears on:ChannelConfig)

FieldDescription
V2_0bool

OrdererEnrollment#

(Appears on:FabricOrderingServiceSpec)

FieldDescription
componentComponent
tlsTLS

OrdererNode#

(Appears on:FabricOrderingServiceSpec)

FieldDescription
idstring
hoststring(Optional)
portint(Optional)
enrollmentOrdererNodeEnrollment

OrdererNodeEnrollment#

(Appears on:OrdererNode)

FieldDescription
tlsOrdererNodeEnrollmentTLS

OrdererNodeEnrollmentTLS#

(Appears on:OrdererNodeEnrollment)

FieldDescription
csrCsr(Optional)

OrdererNodeService#

(Appears on:FabricOrdererNodeSpec)

FieldDescription
typeKubernetes core/v1.ServiceType
nodePortOperationsint
nodePortRequestint

OrdererService#

(Appears on:FabricOrderingServiceSpec)

FieldDescription
typeServiceType

OrdererSystemChannel#

(Appears on:FabricOrderingServiceSpec)

FieldDescription
namestring
configChannelConfig

OrgCertsRef#

PeerService#

(Appears on:FabricPeerSpec)

FieldDescription
typeKubernetes core/v1.ServiceType

Secret#

(Appears on:FabricOrdererNodeSpec,FabricPeerSpec)

FieldDescription
enrollmentEnrollment

Service#

FieldDescription
typeServiceType

ServiceMonitor#

(Appears on:FabricCASpec,FabricOrdererNodeSpec,FabricPeerSpec)

FieldDescription
enabledbool
labelsmap[string]string(Optional)
sampleLimitint
intervalstring
scrapeTimeoutstring

ServiceType (string alias)#

(Appears on:OrdererService,Service)

StateDB (string alias)#

(Appears on:FabricPeerSpec)

Storage#

(Appears on:FabricCASpec,FabricOperationsConsoleCouchDB,FabricOrdererNodeSpec,FabricOrderingServiceSpec,FabricPeerStorage)

FieldDescription
sizestring
storageClassstring(Optional)
accessModeKubernetes core/v1.PersistentVolumeAccessMode

TLS#

(Appears on:Enrollment,FabricChaincodeSpec,OrdererEnrollment)

FieldDescription
cahoststring
canamestring
caportint
catlsCatls
csrCsr(Optional)
enrollidstring
enrollsecretstring

Generated with gen-crd-api-reference-docson git commit 464adb2.