From 6c5f08f2fcee0d50f69113f1956bda373d4a28c0 Mon Sep 17 00:00:00 2001 From: Ratnakar Date: Mon, 11 Dec 2023 08:53:04 -0500 Subject: [PATCH] Updating apis to sync with the current operator APIs (#157) https://github.com/hyperledger-labs/fabric-operator/issues/156 --------- Signed-off-by: asararatnakar --- .github/workflows/basic-tests.yaml | 44 ++++ Makefile | 35 ++++ api/orderer/v1/orderer.go | 188 ------------------ api/orderer/v2/orderer.go | 50 ----- api/v1beta1/common_struct.go | 3 - api/v1beta1/ibpconsole_types.go | 2 +- api/v1beta1/zz_generated.deepcopy.go | 22 +- {api => pkg/apis}/ca/v1/ca.go | 55 +++-- {api => pkg/apis}/common/common.go | 0 {api => pkg/apis}/console/v1/console.go | 56 +++--- .../apis}/console/v1/zz_generated.deepcopy.go | 35 +++- {api => pkg/apis}/deployer/deployer.go | 0 pkg/apis/orderer/v1/orderer.go | 188 ++++++++++++++++++ pkg/apis/orderer/v2/orderer.go | 50 +++++ {api => pkg/apis}/orderer/v24/orderer.go | 34 ++-- pkg/apis/orderer/v25/orderer.go | 35 ++++ {api => pkg/apis}/peer/v1/peer.go | 2 +- {api => pkg/apis}/peer/v2/peer.go | 6 +- {api => pkg/apis}/peer/v25/peer.go | 22 +- scripts/check-licenses.sh | 127 ++++++++++++ scripts/checks.sh | 44 ++++ scripts/copy_apis.sh | 68 +++++++ scripts/go-sec.sh | 23 +++ 23 files changed, 764 insertions(+), 325 deletions(-) create mode 100644 .github/workflows/basic-tests.yaml create mode 100644 Makefile delete mode 100644 api/orderer/v1/orderer.go delete mode 100644 api/orderer/v2/orderer.go rename {api => pkg/apis}/ca/v1/ca.go (86%) rename {api => pkg/apis}/common/common.go (100%) rename {api => pkg/apis}/console/v1/console.go (63%) rename {api => pkg/apis}/console/v1/zz_generated.deepcopy.go (68%) rename {api => pkg/apis}/deployer/deployer.go (100%) create mode 100644 pkg/apis/orderer/v1/orderer.go create mode 100644 pkg/apis/orderer/v2/orderer.go rename {api => pkg/apis}/orderer/v24/orderer.go (58%) create mode 100644 pkg/apis/orderer/v25/orderer.go rename {api => pkg/apis}/peer/v1/peer.go (99%) rename {api => pkg/apis}/peer/v2/peer.go (97%) rename {api => pkg/apis}/peer/v25/peer.go (92%) create mode 100755 scripts/check-licenses.sh create mode 100755 scripts/checks.sh create mode 100755 scripts/copy_apis.sh create mode 100755 scripts/go-sec.sh diff --git a/.github/workflows/basic-tests.yaml b/.github/workflows/basic-tests.yaml new file mode 100644 index 00000000..8479e600 --- /dev/null +++ b/.github/workflows/basic-tests.yaml @@ -0,0 +1,44 @@ +# +# Copyright contributors to the Hyperledger Fabric Operator project +# +# SPDX-License-Identifier: Apache-2.0 +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +name: basic-tests + +on: + push: + branches: [api] + pull_request: + branches: [api] + +env: + GO_VER: 1.18 + +jobs: + make-checks: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up go + uses: actions/setup-go@v3 + with: + go-version: ${{ env.GO_VER }} + - name: license header checks + run: make check-license + - name: gosec + run: make go-sec + - name: Run vet and format checks + run: make checks \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..311ce267 --- /dev/null +++ b/Makefile @@ -0,0 +1,35 @@ +# +# Copyright contributors to the Hyperledger Fabric Operator project +# +# SPDX-License-Identifier: Apache-2.0 +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +## license checks +check-license: + @scripts/check-licenses.sh + +# Run go fmt against code +fmt: + go fmt ./... + +# Run go vet against code +vet: + @scripts/checks.sh + +checks: fmt vet + +# gosec checks +go-sec: + @scripts/go-sec.sh \ No newline at end of file diff --git a/api/orderer/v1/orderer.go b/api/orderer/v1/orderer.go deleted file mode 100644 index be1e5383..00000000 --- a/api/orderer/v1/orderer.go +++ /dev/null @@ -1,188 +0,0 @@ -/* - * Copyright contributors to the Hyperledger Fabric Operator project - * - * SPDX-License-Identifier: Apache-2.0 - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package v1 - -import ( - "github.com/IBM-Blockchain/fabric-operator/api/common" -) - -type Orderer struct { - General General `json:"general,omitempty"` - FileLedger FileLedger `json:"fileLedger,omitempty"` - Debug Debug `json:"debug,omitempty"` - Consensus interface{} `json:"consensus,omitempty"` - Operations Operations `json:"operations,omitempty"` - Metrics Metrics `json:"metrics,omitempty"` -} - -// General contains config which should be common among all orderer types. -type General struct { - LedgerType string `json:"ledgerType,omitempty"` - ListenAddress string `json:"listenAddress,omitempty"` - ListenPort uint16 `json:"listenPort,omitempty"` - TLS TLS `json:"tls,omitempty"` - Cluster Cluster `json:"cluster,omitempty"` - Keepalive Keepalive `json:"keepalive,omitempty"` - ConnectionTimeout common.Duration `json:"connectionTimeout,omitempty"` - GenesisMethod string `json:"genesisMethod,omitempty"` - GenesisFile string `json:"genesisFile,omitempty"` // For compatibility only, will be replaced by BootstrapFile - BootstrapFile string `json:"bootstrapFile,omitempty"` - Profile Profile `json:"profile,omitempty"` - LocalMSPDir string `json:"localMspDir,omitempty"` - LocalMSPID string `json:"localMspId,omitempty"` - BCCSP *common.BCCSP `json:"BCCSP,omitempty"` - Authentication Authentication `json:"authentication,omitempty"` -} - -type Cluster struct { - ListenAddress string `json:"listenAddress,omitempty"` - ListenPort uint16 `json:"listenPort,omitempty"` - ServerCertificate string `json:"serverCertificate,omitempty"` - ServerPrivateKey string `json:"serverPrivateKey,omitempty"` - ClientCertificate string `json:"clientCertificate,omitempty"` - ClientPrivateKey string `json:"clientPrivateKey,omitempty"` - RootCAs []string `json:"rootCas,omitempty"` - DialTimeout common.Duration `json:"dialTimeout,omitempty"` - RPCTimeout common.Duration `json:"rpcTimeout,omitempty"` - ReplicationBufferSize int `json:"replicationBufferSize,omitempty"` - ReplicationPullTimeout common.Duration `json:"replicationPullTimeout,omitempty"` - ReplicationRetryTimeout common.Duration `json:"replicationRetryTimeout,omitempty"` - ReplicationBackgroundRefreshInterval common.Duration `json:"replicationBackgroundRefreshInterval,omitempty"` - ReplicationMaxRetries int `json:"replicationMaxRetries,omitempty"` - SendBufferSize int `json:"sendBufferSize,omitempty"` - CertExpirationWarningThreshold common.Duration `json:"certExpirationWarningThreshold,omitempty"` - TLSHandshakeTimeShift common.Duration `json:"tlsHandshakeTimeShift,omitempty"` -} - -// Keepalive contains configuration for gRPC servers. -type Keepalive struct { - ServerMinInterval common.Duration `json:"serverMinInterval,omitempty"` - ServerInterval common.Duration `json:"serverInterval,omitempty"` - ServerTimeout common.Duration `json:"serverTimeout,omitempty"` -} - -// TLS contains configuration for TLS connections. -type TLS struct { - Enabled *bool `json:"enabled,omitempty"` - PrivateKey string `json:"privateKey,omitempty"` - Certificate string `json:"certificate,omitempty"` - RootCAs []string `json:"rootCas,omitempty"` - ClientAuthRequired *bool `json:"clientAuthRequired,omitempty"` - ClientRootCAs []string `json:"clientRootCas,omitempty"` -} - -// SASLPlain contains configuration for SASL/PLAIN authentication -type SASLPlain struct { - Enabled *bool `json:"enabled,omitempty"` - User string `json:"user,omitempty"` - Password string `json:"password,omitempty"` -} - -// Authentication contains configuration parameters related to authenticating -// client messages. -type Authentication struct { - TimeWindow common.Duration `json:"timeWindow,omitempty"` - NoExpirationChecks *bool `json:"noExpirationChecks,omitempty"` -} - -// Profile contains configuration for Go pprof profiling. -type Profile struct { - Enabled *bool `json:"enabled,omitempty"` - Address string `json:"address,omitempty"` -} - -// FileLedger contains configuration for the file-based ledger. -type FileLedger struct { - Location string `json:"location,omitempty"` - Prefix string `json:"prefix,omitempty"` -} - -// Retry contains configuration related to retries and timeouts when the -// connection to the Kafka cluster cannot be established, or when Metadata -// requests needs to be repeated (because the cluster is in the middle of a -// leader election). -type Retry struct { - ShortInterval common.Duration `json:"shortInterval,omitempty"` - ShortTotal common.Duration `json:"shortTotal,omitempty"` - LongInterval common.Duration `json:"longInterval,omitempty"` - LongTotal common.Duration `json:"longTotal,omitempty"` - NetworkTimeouts NetworkTimeouts `json:"networkTimeouts,omitempty"` - Metadata Metadata `json:"metadata,omitempty"` - Producer Producer `json:"producer,omitempty"` - Consumer Consumer `json:"consumer,omitempty"` -} - -// NetworkTimeouts contains the socket timeouts for network requests to the -// Kafka cluster. -type NetworkTimeouts struct { - DialTimeout common.Duration `json:"dialTimeout,omitempty"` - ReadTimeout common.Duration `json:"readTimeout,omitempty"` - WriteTimeout common.Duration `json:"writeTimeout,omitempty"` -} - -// Metadata contains configuration for the metadata requests to the Kafka -// cluster. -type Metadata struct { - RetryMax int `json:"retryMax,omitempty"` - RetryBackoff common.Duration `json:"retryBackoff,omitempty"` -} - -// Producer contains configuration for the producer's retries when failing to -// post a message to a Kafka partition. -type Producer struct { - RetryMax int `json:"retryMax,omitempty"` - RetryBackoff common.Duration `json:"retryBackoff,omitempty"` -} - -// Consumer contains configuration for the consumer's retries when failing to -// read from a Kafa partition. -type Consumer struct { - RetryBackoff common.Duration `json:"retryBackoff,omitempty"` -} - -// Topic contains the settings to use when creating Kafka topics -type Topic struct { - ReplicationFactor int16 `json:"replicationFactor,omitempty"` -} - -// Debug contains configuration for the orderer's debug parameters. -type Debug struct { - BroadcastTraceDir string `json:"broadcastTraceDir,omitempty"` - DeliverTraceDir string `json:"deliverTraceDir,omitempty"` -} - -// Operations configures the operations endpont for the orderer. -type Operations struct { - ListenAddress string `json:"listenAddress,omitempty"` - TLS TLS `json:"tls,omitempty"` -} - -// Operations confiures the metrics provider for the orderer. -type Metrics struct { - Provider string `json:"provider,omitempty"` - Statsd Statsd `json:"statsd,omitempty"` -} - -// Statsd provides the configuration required to emit statsd metrics from the orderer. -type Statsd struct { - Network string `json:"network,omitempty"` - Address string `json:"address,omitempty"` - WriteInterval common.Duration `json:"writeInterval,omitempty"` - Prefix string `json:"prefix,omitempty"` -} diff --git a/api/orderer/v2/orderer.go b/api/orderer/v2/orderer.go deleted file mode 100644 index 3e3e7918..00000000 --- a/api/orderer/v2/orderer.go +++ /dev/null @@ -1,50 +0,0 @@ -/* - * Copyright contributors to the Hyperledger Fabric Operator project - * - * SPDX-License-Identifier: Apache-2.0 - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package v2 - -import ( - "github.com/IBM-Blockchain/fabric-operator/api/common" - v1 "github.com/IBM-Blockchain/fabric-operator/api/orderer/v1" -) - -type Orderer struct { - General General `json:"general,omitempty"` - FileLedger v1.FileLedger `json:"fileLedger,omitempty"` - Debug v1.Debug `json:"debug,omitempty"` - Consensus interface{} `json:"consensus,omitempty"` - Operations v1.Operations `json:"operations,omitempty"` - Metrics v1.Metrics `json:"metrics,omitempty"` -} - -type General struct { - ListenAddress string `json:"listenAddress,omitempty"` - ListenPort uint16 `json:"listenPort,omitempty"` - TLS v1.TLS `json:"tls,omitempty"` - Cluster v1.Cluster `json:"cluster,omitempty"` - Keepalive v1.Keepalive `json:"keepalive,omitempty"` - ConnectionTimeout common.Duration `json:"connectionTimeout,omitempty"` - GenesisFile string `json:"genesisFile,omitempty"` // For compatibility only, will be replaced by BootstrapFile - BootstrapFile string `json:"bootstrapFile,omitempty"` - BootstrapMethod string `json:"bootstrapMethod,omitempty"` - Profile v1.Profile `json:"profile,omitempty"` - LocalMSPDir string `json:"localMspDir,omitempty"` - LocalMSPID string `json:"localMspId,omitempty"` - BCCSP *common.BCCSP `json:"BCCSP,omitempty"` - Authentication v1.Authentication `json:"authentication,omitempty"` -} diff --git a/api/v1beta1/common_struct.go b/api/v1beta1/common_struct.go index adb6bf27..b13114e1 100644 --- a/api/v1beta1/common_struct.go +++ b/api/v1beta1/common_struct.go @@ -22,9 +22,6 @@ import ( corev1 "k8s.io/api/core/v1" ) -var BoolTrue = true -var BoolFalse = false - // Service is the overrides to be used for Service of the component // +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true type Service struct { diff --git a/api/v1beta1/ibpconsole_types.go b/api/v1beta1/ibpconsole_types.go index 2c9e17a0..d6d3b9d0 100644 --- a/api/v1beta1/ibpconsole_types.go +++ b/api/v1beta1/ibpconsole_types.go @@ -19,7 +19,7 @@ package v1beta1 import ( - consolev1 "github.com/IBM-Blockchain/fabric-operator/api/console/v1" + consolev1 "github.com/IBM-Blockchain/fabric-operator/pkg/apis/console/v1" corev1 "k8s.io/api/core/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/runtime" diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go index 40305010..7a28711a 100644 --- a/api/v1beta1/zz_generated.deepcopy.go +++ b/api/v1beta1/zz_generated.deepcopy.go @@ -1,12 +1,30 @@ //go:build !ignore_autogenerated // +build !ignore_autogenerated -// Code generated by operator-sdk. DO NOT EDIT. +/* + * Copyright contributors to the Hyperledger Fabric Operator project + * + * SPDX-License-Identifier: Apache-2.0 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Code generated by controller-gen. DO NOT EDIT. package v1beta1 import ( - consolev1 "github.com/IBM-Blockchain/fabric-operator/api/console/v1" + consolev1 "github.com/IBM-Blockchain/fabric-operator/pkg/apis/console/v1" "k8s.io/api/core/v1" "k8s.io/apimachinery/pkg/runtime" ) diff --git a/api/ca/v1/ca.go b/pkg/apis/ca/v1/ca.go similarity index 86% rename from api/ca/v1/ca.go rename to pkg/apis/ca/v1/ca.go index 21e0d311..7c5ff128 100644 --- a/api/ca/v1/ca.go +++ b/pkg/apis/ca/v1/ca.go @@ -19,7 +19,7 @@ package v1 import ( - "github.com/IBM-Blockchain/fabric-operator/api/common" + commonapi "github.com/IBM-Blockchain/fabric-operator/pkg/apis/common" ) // ServerConfig is the fabric-ca server's config @@ -88,6 +88,7 @@ type CAConfig struct { CSP *BCCSP `json:"bccsp,omitempty"` Intermediate IntermediateCA `json:"intermediate,omitempty"` CRL CRLConfig `json:"crl,omitempty"` + Idemix IdemixConfig `json:"idemix,omitempty"` // Optional client config for an intermediate server which acts as a client // of the root (or parent) server @@ -170,21 +171,21 @@ type Signing struct { // A SigningProfile stores information that the CA needs to store // signature policy. type SigningProfile struct { - Usage []string `json:"usage,omitempty"` - IssuerURL []string `json:"issuerurl,omitempty"` - OCSP string `json:"ocsp,omitempty"` - CRL string `json:"crl,omitempty"` - CAConstraint CAConstraint `json:"caconstraint,omitempty"` - OCSPNoCheck *bool `json:"ocspnocheck,omitempty"` - ExpiryString string `json:"expirystring,omitempty"` - BackdateString string `json:"backdatestring,omitempty"` - AuthKeyName string `json:"authkeyname,omitempty"` - RemoteName string `json:"remotename,omitempty"` - NameWhitelistString string `json:"namewhiteliststring,omitempty"` - AuthRemote AuthRemote `json:"authremote,omitempty"` - CTLogServers []string `json:"ctlogservers,omitempty"` - CertStore string `json:"certstore,omitempty"` - Expiry common.Duration `json:"expiry,omitempty"` + Usage []string `json:"usage,omitempty"` + IssuerURL []string `json:"issuerurl,omitempty"` + OCSP string `json:"ocsp,omitempty"` + CRL string `json:"crl,omitempty"` + CAConstraint CAConstraint `json:"caconstraint,omitempty"` + OCSPNoCheck *bool `json:"ocspnocheck,omitempty"` + ExpiryString string `json:"expirystring,omitempty"` + BackdateString string `json:"backdatestring,omitempty"` + AuthKeyName string `json:"authkeyname,omitempty"` + RemoteName string `json:"remotename,omitempty"` + NameWhitelistString string `json:"namewhiteliststring,omitempty"` + AuthRemote AuthRemote `json:"authremote,omitempty"` + CTLogServers []string `json:"ctlogservers,omitempty"` + CertStore string `json:"certstore,omitempty"` + Expiry commonapi.Duration `json:"expiry,omitempty"` // TODO: Do these need to be overridable? // AllowedExtensions []cfconfig.OID `json:"allowedextensions,omitempty"` @@ -340,7 +341,19 @@ type CRLConfig struct { // Specifies expiration for the CRL generated by the gencrl request // The number of hours specified by this property is added to the UTC time, resulting time // is used to set the 'Next Update' date of the CRL - Expiry common.Duration `json:"expiry,omitempty"` + Expiry commonapi.Duration `json:"expiry,omitempty"` +} + +// IdemixConfig encapsulates Idemix related the configuration options +type IdemixConfig struct { + Curve string `json:"curve,omitempty"` + IssuerPublicKeyfile string `json:"issuerpublickeyfile,omitempty"` + IssuerSecretKeyfile string `json:"issuersecretkeyfile,omitempty"` + RevocationPublicKeyfile string `json:"revocationpublickeyfile,omitempty"` + RevocationPrivateKeyfile string `json:"revocationprivatekeyfile,omitempty"` + RHPoolSize int `json:"rhpoolsize,omitempty"` + NonceExpiration string `json:"nonceexpiration,omitempty"` + NonceSweepInterval string `json:"noncesweepinterval,omitempty"` } // Options contains configuration for the operations system @@ -367,8 +380,8 @@ type TLS struct { // Statsd contains configuration of statsd type Statsd struct { - Network string `json:"network,omitempty"` - Address string `json:"address,omitempty"` - WriteInterval common.Duration `json:"writeinterval,omitempty"` - Prefix string `json:"prefix,omitempty"` + Network string `json:"network,omitempty"` + Address string `json:"address,omitempty"` + WriteInterval commonapi.Duration `json:"writeinterval,omitempty"` + Prefix string `json:"prefix,omitempty"` } diff --git a/api/common/common.go b/pkg/apis/common/common.go similarity index 100% rename from api/common/common.go rename to pkg/apis/common/common.go diff --git a/api/console/v1/console.go b/pkg/apis/console/v1/console.go similarity index 63% rename from api/console/v1/console.go rename to pkg/apis/console/v1/console.go index 5bbedade..d160f2c0 100644 --- a/api/console/v1/console.go +++ b/pkg/apis/console/v1/console.go @@ -59,6 +59,8 @@ type InfraImportOptions struct { // +k8s:deepcopy-gen=true type FeatureFlags struct { + ImportOnlyEnabled *bool `json:"import_only_enabled,omitempty"` + ReadOnlyEnabled *bool `json:"read_only_enabled,omitempty"` CreateChannelEnabled bool `json:"create_channel_enabled,omitempty"` RemotePeerConfigEnabled bool `json:"remote_peer_config_enabled,omitempty"` SaasEnabled bool `json:"saas_enabled,omitempty"` @@ -73,7 +75,6 @@ type FeatureFlags struct { Patch14to20Enabled bool `json:"patch_1_4to2_x_enabled,omitempty"` DevMode bool `json:"dev_mode,omitempty"` MustgatherEnabled bool `json:"mustgather_enabled,omitempty"` - OsnAdminEnabled bool `json:"osnadmin_feats_enabled,omitempty"` } // Added here to avoid the Circular dependency @@ -90,30 +91,31 @@ type CRN struct { } type ConsoleSettingsConfig struct { - Version string `json:"version"` - Email string `json:"initial_admin"` - AuthScheme string `json:"auth_scheme"` - Configtxlator string `json:"configtxlator"` - DeployerURL string `json:"deployer_url"` - DeployerTimeout int32 `json:"deployer_timeout"` - HSM string `json:"hsm"` - SegmentWriteKey string `json:"segment_write_key"` - DBCustomNames DBCustomNames `json:"db_custom_names"` - EnforceBackendSSL bool `json:"enforce_backend_ssl"` - SystemChannelID string `json:"system_channel_id"` - DynamicTLS bool `json:"dynamic_tls"` - DynamicConfig bool `json:"dynamic_config"` - Zone string `json:"zone"` - Infrastructure string `json:"infrastructure"` - FabricCapabilites FabricCapabilites `json:"fabric_capabilities"` - ClusterData *IBPConsoleClusterData `json:"cluster_data"` - ProxyTLSReqs string `json:"proxy_tls_fabric_reqs"` - ProxyTLSUrl string `json:"proxy_tls_ws_url"` - Featureflags *FeatureFlags `json:"feature_flags"` - IBMID *IBMID `json:"ibmid,omitempty"` - IAMApiKey string `json:"iam_api_key,omitempty"` - CRN *CRN `json:"crn,omitempty"` - CRNString string `json:"crn_string,omitempty"` - ActivityTrackerPath string `json:"activity_tracker_path,omitempty"` - TrustProxy string `json:"trust_proxy,omitempty"` + Version string `json:"version"` + Email string `json:"initial_admin"` + AuthScheme string `json:"auth_scheme,omitempty"` + AllowDefaultPassword bool `json:"allow_default_password"` + Configtxlator string `json:"configtxlator"` + DeployerURL string `json:"deployer_url"` + DeployerTimeout int32 `json:"deployer_timeout"` + HSM string `json:"hsm"` + SegmentWriteKey string `json:"segment_write_key"` + DBCustomNames DBCustomNames `json:"db_custom_names"` + EnforceBackendSSL bool `json:"enforce_backend_ssl"` + SystemChannelID string `json:"system_channel_id"` + DynamicTLS bool `json:"dynamic_tls"` + DynamicConfig bool `json:"dynamic_config"` + Zone string `json:"zone"` + Infrastructure string `json:"infrastructure"` + FabricCapabilites FabricCapabilites `json:"fabric_capabilities"` + ClusterData *IBPConsoleClusterData `json:"cluster_data"` + ProxyTLSReqs string `json:"proxy_tls_fabric_reqs"` + ProxyTLSUrl string `json:"proxy_tls_ws_url"` + Featureflags *FeatureFlags `json:"feature_flags"` + IBMID *IBMID `json:"ibmid,omitempty"` + IAMApiKey string `json:"iam_api_key,omitempty"` + CRN *CRN `json:"crn,omitempty"` + CRNString string `json:"crn_string,omitempty"` + ActivityTrackerPath string `json:"activity_tracker_path,omitempty"` + TrustProxy string `json:"trust_proxy,omitempty"` } diff --git a/api/console/v1/zz_generated.deepcopy.go b/pkg/apis/console/v1/zz_generated.deepcopy.go similarity index 68% rename from api/console/v1/zz_generated.deepcopy.go rename to pkg/apis/console/v1/zz_generated.deepcopy.go index 5dd13a6d..0a4d7a89 100644 --- a/api/console/v1/zz_generated.deepcopy.go +++ b/pkg/apis/console/v1/zz_generated.deepcopy.go @@ -1,19 +1,48 @@ //go:build !ignore_autogenerated // +build !ignore_autogenerated -// Code generated by operator-sdk. DO NOT EDIT. +/* + * Copyright contributors to the Hyperledger Fabric Operator project + * + * SPDX-License-Identifier: Apache-2.0 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Code generated by controller-gen. DO NOT EDIT. package v1 +import () + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *FeatureFlags) DeepCopyInto(out *FeatureFlags) { *out = *in + if in.ImportOnlyEnabled != nil { + in, out := &in.ImportOnlyEnabled, &out.ImportOnlyEnabled + *out = new(bool) + **out = **in + } + if in.ReadOnlyEnabled != nil { + in, out := &in.ReadOnlyEnabled, &out.ReadOnlyEnabled + *out = new(bool) + **out = **in + } if in.InfraImportOptions != nil { in, out := &in.InfraImportOptions, &out.InfraImportOptions *out = new(InfraImportOptions) (*in).DeepCopyInto(*out) } - return } // DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FeatureFlags. @@ -34,7 +63,6 @@ func (in *IBPConsoleClusterData) DeepCopyInto(out *IBPConsoleClusterData) { *out = make([]string, len(*in)) copy(*out, *in) } - return } // DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IBPConsoleClusterData. @@ -65,7 +93,6 @@ func (in *InfraImportOptions) DeepCopyInto(out *InfraImportOptions) { *out = make([]string, len(*in)) copy(*out, *in) } - return } // DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InfraImportOptions. diff --git a/api/deployer/deployer.go b/pkg/apis/deployer/deployer.go similarity index 100% rename from api/deployer/deployer.go rename to pkg/apis/deployer/deployer.go diff --git a/pkg/apis/orderer/v1/orderer.go b/pkg/apis/orderer/v1/orderer.go new file mode 100644 index 00000000..e01c0e1b --- /dev/null +++ b/pkg/apis/orderer/v1/orderer.go @@ -0,0 +1,188 @@ +/* + * Copyright contributors to the Hyperledger Fabric Operator project + * + * SPDX-License-Identifier: Apache-2.0 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package v1 + +import ( + commonapi "github.com/IBM-Blockchain/fabric-operator/pkg/apis/common" +) + +type Orderer struct { + General General `json:"general,omitempty"` + FileLedger FileLedger `json:"fileLedger,omitempty"` + Debug Debug `json:"debug,omitempty"` + Consensus interface{} `json:"consensus,omitempty"` + Operations Operations `json:"operations,omitempty"` + Metrics Metrics `json:"metrics,omitempty"` +} + +// General contains config which should be common among all orderer types. +type General struct { + LedgerType string `json:"ledgerType,omitempty"` + ListenAddress string `json:"listenAddress,omitempty"` + ListenPort uint16 `json:"listenPort,omitempty"` + TLS TLS `json:"tls,omitempty"` + Cluster Cluster `json:"cluster,omitempty"` + Keepalive Keepalive `json:"keepalive,omitempty"` + ConnectionTimeout commonapi.Duration `json:"connectionTimeout,omitempty"` + GenesisMethod string `json:"genesisMethod,omitempty"` + GenesisFile string `json:"genesisFile,omitempty"` // For compatibility only, will be replaced by BootstrapFile + BootstrapFile string `json:"bootstrapFile,omitempty"` + Profile Profile `json:"profile,omitempty"` + LocalMSPDir string `json:"localMspDir,omitempty"` + LocalMSPID string `json:"localMspId,omitempty"` + BCCSP *commonapi.BCCSP `json:"BCCSP,omitempty"` + Authentication Authentication `json:"authentication,omitempty"` +} + +type Cluster struct { + ListenAddress string `json:"listenAddress,omitempty"` + ListenPort uint16 `json:"listenPort,omitempty"` + ServerCertificate string `json:"serverCertificate,omitempty"` + ServerPrivateKey string `json:"serverPrivateKey,omitempty"` + ClientCertificate string `json:"clientCertificate,omitempty"` + ClientPrivateKey string `json:"clientPrivateKey,omitempty"` + RootCAs []string `json:"rootCas,omitempty"` + DialTimeout commonapi.Duration `json:"dialTimeout,omitempty"` + RPCTimeout commonapi.Duration `json:"rpcTimeout,omitempty"` + ReplicationBufferSize int `json:"replicationBufferSize,omitempty"` + ReplicationPullTimeout commonapi.Duration `json:"replicationPullTimeout,omitempty"` + ReplicationRetryTimeout commonapi.Duration `json:"replicationRetryTimeout,omitempty"` + ReplicationBackgroundRefreshInterval commonapi.Duration `json:"replicationBackgroundRefreshInterval,omitempty"` + ReplicationMaxRetries int `json:"replicationMaxRetries,omitempty"` + SendBufferSize int `json:"sendBufferSize,omitempty"` + CertExpirationWarningThreshold commonapi.Duration `json:"certExpirationWarningThreshold,omitempty"` + TLSHandshakeTimeShift commonapi.Duration `json:"tlsHandshakeTimeShift,omitempty"` +} + +// Keepalive contains configuration for gRPC servers. +type Keepalive struct { + ServerMinInterval commonapi.Duration `json:"serverMinInterval,omitempty"` + ServerInterval commonapi.Duration `json:"serverInterval,omitempty"` + ServerTimeout commonapi.Duration `json:"serverTimeout,omitempty"` +} + +// TLS contains configuration for TLS connections. +type TLS struct { + Enabled *bool `json:"enabled,omitempty"` + PrivateKey string `json:"privateKey,omitempty"` + Certificate string `json:"certificate,omitempty"` + RootCAs []string `json:"rootCas,omitempty"` + ClientAuthRequired *bool `json:"clientAuthRequired,omitempty"` + ClientRootCAs []string `json:"clientRootCas,omitempty"` +} + +// SASLPlain contains configuration for SASL/PLAIN authentication +type SASLPlain struct { + Enabled *bool `json:"enabled,omitempty"` + User string `json:"user,omitempty"` + Password string `json:"password,omitempty"` +} + +// Authentication contains configuration parameters related to authenticating +// client messages. +type Authentication struct { + TimeWindow commonapi.Duration `json:"timeWindow,omitempty"` + NoExpirationChecks *bool `json:"noExpirationChecks,omitempty"` +} + +// Profile contains configuration for Go pprof profiling. +type Profile struct { + Enabled *bool `json:"enabled,omitempty"` + Address string `json:"address,omitempty"` +} + +// FileLedger contains configuration for the file-based ledger. +type FileLedger struct { + Location string `json:"location,omitempty"` + Prefix string `json:"prefix,omitempty"` +} + +// Retry contains configuration related to retries and timeouts when the +// connection to the Kafka cluster cannot be established, or when Metadata +// requests needs to be repeated (because the cluster is in the middle of a +// leader election). +type Retry struct { + ShortInterval commonapi.Duration `json:"shortInterval,omitempty"` + ShortTotal commonapi.Duration `json:"shortTotal,omitempty"` + LongInterval commonapi.Duration `json:"longInterval,omitempty"` + LongTotal commonapi.Duration `json:"longTotal,omitempty"` + NetworkTimeouts NetworkTimeouts `json:"networkTimeouts,omitempty"` + Metadata Metadata `json:"metadata,omitempty"` + Producer Producer `json:"producer,omitempty"` + Consumer Consumer `json:"consumer,omitempty"` +} + +// NetworkTimeouts contains the socket timeouts for network requests to the +// Kafka cluster. +type NetworkTimeouts struct { + DialTimeout commonapi.Duration `json:"dialTimeout,omitempty"` + ReadTimeout commonapi.Duration `json:"readTimeout,omitempty"` + WriteTimeout commonapi.Duration `json:"writeTimeout,omitempty"` +} + +// Metadata contains configuration for the metadata requests to the Kafka +// cluster. +type Metadata struct { + RetryMax int `json:"retryMax,omitempty"` + RetryBackoff commonapi.Duration `json:"retryBackoff,omitempty"` +} + +// Producer contains configuration for the producer's retries when failing to +// post a message to a Kafka partition. +type Producer struct { + RetryMax int `json:"retryMax,omitempty"` + RetryBackoff commonapi.Duration `json:"retryBackoff,omitempty"` +} + +// Consumer contains configuration for the consumer's retries when failing to +// read from a Kafa partition. +type Consumer struct { + RetryBackoff commonapi.Duration `json:"retryBackoff,omitempty"` +} + +// Topic contains the settings to use when creating Kafka topics +type Topic struct { + ReplicationFactor int16 `json:"replicationFactor,omitempty"` +} + +// Debug contains configuration for the orderer's debug parameters. +type Debug struct { + BroadcastTraceDir string `json:"broadcastTraceDir,omitempty"` + DeliverTraceDir string `json:"deliverTraceDir,omitempty"` +} + +// Operations configures the operations endpont for the orderer. +type Operations struct { + ListenAddress string `json:"listenAddress,omitempty"` + TLS TLS `json:"tls,omitempty"` +} + +// Operations confiures the metrics provider for the orderer. +type Metrics struct { + Provider string `json:"provider,omitempty"` + Statsd Statsd `json:"statsd,omitempty"` +} + +// Statsd provides the configuration required to emit statsd metrics from the orderer. +type Statsd struct { + Network string `json:"network,omitempty"` + Address string `json:"address,omitempty"` + WriteInterval commonapi.Duration `json:"writeInterval,omitempty"` + Prefix string `json:"prefix,omitempty"` +} diff --git a/pkg/apis/orderer/v2/orderer.go b/pkg/apis/orderer/v2/orderer.go new file mode 100644 index 00000000..59ebe244 --- /dev/null +++ b/pkg/apis/orderer/v2/orderer.go @@ -0,0 +1,50 @@ +/* + * Copyright contributors to the Hyperledger Fabric Operator project + * + * SPDX-License-Identifier: Apache-2.0 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package v2 + +import ( + commonapi "github.com/IBM-Blockchain/fabric-operator/pkg/apis/common" + v1 "github.com/IBM-Blockchain/fabric-operator/pkg/apis/orderer/v1" +) + +type Orderer struct { + General General `json:"general,omitempty"` + FileLedger v1.FileLedger `json:"fileLedger,omitempty"` + Debug v1.Debug `json:"debug,omitempty"` + Consensus interface{} `json:"consensus,omitempty"` + Operations v1.Operations `json:"operations,omitempty"` + Metrics v1.Metrics `json:"metrics,omitempty"` +} + +type General struct { + ListenAddress string `json:"listenAddress,omitempty"` + ListenPort uint16 `json:"listenPort,omitempty"` + TLS v1.TLS `json:"tls,omitempty"` + Cluster v1.Cluster `json:"cluster,omitempty"` + Keepalive v1.Keepalive `json:"keepalive,omitempty"` + ConnectionTimeout commonapi.Duration `json:"connectionTimeout,omitempty"` + GenesisFile string `json:"genesisFile,omitempty"` // For compatibility only, will be replaced by BootstrapFile + BootstrapFile string `json:"bootstrapFile,omitempty"` + BootstrapMethod string `json:"bootstrapMethod,omitempty"` + Profile v1.Profile `json:"profile,omitempty"` + LocalMSPDir string `json:"localMspDir,omitempty"` + LocalMSPID string `json:"localMspId,omitempty"` + BCCSP *commonapi.BCCSP `json:"BCCSP,omitempty"` + Authentication v1.Authentication `json:"authentication,omitempty"` +} diff --git a/api/orderer/v24/orderer.go b/pkg/apis/orderer/v24/orderer.go similarity index 58% rename from api/orderer/v24/orderer.go rename to pkg/apis/orderer/v24/orderer.go index 42ce69af..f7181bb4 100644 --- a/api/orderer/v24/orderer.go +++ b/pkg/apis/orderer/v24/orderer.go @@ -19,8 +19,8 @@ package v24 import ( - "github.com/IBM-Blockchain/fabric-operator/api/common" - v1 "github.com/IBM-Blockchain/fabric-operator/api/orderer/v1" + commonapi "github.com/IBM-Blockchain/fabric-operator/pkg/apis/common" + v1 "github.com/IBM-Blockchain/fabric-operator/pkg/apis/orderer/v1" ) type Orderer struct { @@ -35,20 +35,22 @@ type Orderer struct { } type General struct { - ListenAddress string `json:"listenAddress,omitempty"` - ListenPort uint16 `json:"listenPort,omitempty"` - TLS v1.TLS `json:"tls,omitempty"` - Cluster v1.Cluster `json:"cluster,omitempty"` - Keepalive v1.Keepalive `json:"keepalive,omitempty"` - ConnectionTimeout common.Duration `json:"connectionTimeout,omitempty"` - GenesisFile string `json:"genesisFile,omitempty"` // For compatibility only, will be replaced by BootstrapFile - BootstrapFile string `json:"bootstrapFile,omitempty"` - BootstrapMethod string `json:"bootstrapMethod,omitempty"` - Profile v1.Profile `json:"profile,omitempty"` - LocalMSPDir string `json:"localMspDir,omitempty"` - LocalMSPID string `json:"localMspId,omitempty"` - BCCSP *common.BCCSP `json:"BCCSP,omitempty"` - Authentication v1.Authentication `json:"authentication,omitempty"` + ListenAddress string `json:"listenAddress,omitempty"` + ListenPort uint16 `json:"listenPort,omitempty"` + TLS v1.TLS `json:"tls,omitempty"` + Cluster v1.Cluster `json:"cluster,omitempty"` + Keepalive v1.Keepalive `json:"keepalive,omitempty"` + ConnectionTimeout commonapi.Duration `json:"connectionTimeout,omitempty"` + GenesisFile string `json:"genesisFile,omitempty"` // For compatibility only, will be replaced by BootstrapFile + BootstrapFile string `json:"bootstrapFile,omitempty"` + BootstrapMethod string `json:"bootstrapMethod,omitempty"` + Profile v1.Profile `json:"profile,omitempty"` + LocalMSPDir string `json:"localMspDir,omitempty"` + LocalMSPID string `json:"localMspId,omitempty"` + BCCSP *commonapi.BCCSP `json:"BCCSP,omitempty"` + Authentication v1.Authentication `json:"authentication,omitempty"` + MaxRecvMsgSize int `json:"maxRecvMsgSize,omitempty"` + MaxSendMsgSize int `json:"maxSendMsgSize,omitempty"` } // FileLedger contains configuration for the file-based ledger. diff --git a/pkg/apis/orderer/v25/orderer.go b/pkg/apis/orderer/v25/orderer.go new file mode 100644 index 00000000..c837fa08 --- /dev/null +++ b/pkg/apis/orderer/v25/orderer.go @@ -0,0 +1,35 @@ +/* + * Copyright contributors to the Hyperledger Fabric Operator project + * + * SPDX-License-Identifier: Apache-2.0 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package v25 + +import ( + v1 "github.com/IBM-Blockchain/fabric-operator/pkg/apis/orderer/v1" + v2 "github.com/IBM-Blockchain/fabric-operator/pkg/apis/orderer/v24" +) + +type Orderer struct { + General v2.General `json:"general,omitempty"` + FileLedger v2.FileLedger `json:"fileLedger,omitempty"` + Debug v1.Debug `json:"debug,omitempty"` + Consensus interface{} `json:"consensus,omitempty"` + Operations v1.Operations `json:"operations,omitempty"` + Metrics v1.Metrics `json:"metrics,omitempty"` + Admin v2.Admin `json:"admin,omitempty"` + ChannelParticipation v2.ChannelParticipation `json:"channelParticipation,omitempty"` +} diff --git a/api/peer/v1/peer.go b/pkg/apis/peer/v1/peer.go similarity index 99% rename from api/peer/v1/peer.go rename to pkg/apis/peer/v1/peer.go index 81823019..3cacdf43 100644 --- a/api/peer/v1/peer.go +++ b/pkg/apis/peer/v1/peer.go @@ -19,7 +19,7 @@ package v1 import ( - "github.com/IBM-Blockchain/fabric-operator/api/common" + "github.com/IBM-Blockchain/fabric-operator/pkg/apis/common" "github.com/docker/docker/api/types/container" ) diff --git a/api/peer/v2/peer.go b/pkg/apis/peer/v2/peer.go similarity index 97% rename from api/peer/v2/peer.go rename to pkg/apis/peer/v2/peer.go index 50d38d96..c0497093 100644 --- a/api/peer/v2/peer.go +++ b/pkg/apis/peer/v2/peer.go @@ -19,8 +19,8 @@ package v2 import ( - "github.com/IBM-Blockchain/fabric-operator/api/common" - v1 "github.com/IBM-Blockchain/fabric-operator/api/peer/v1" + "github.com/IBM-Blockchain/fabric-operator/pkg/apis/common" + v1 "github.com/IBM-Blockchain/fabric-operator/pkg/apis/peer/v1" ) type Core struct { @@ -60,6 +60,8 @@ type Peer struct { ValidatorPoolSize int `json:"validatorPoolSize,omitempty"` Discovery v1.Discovery `json:"discovery,omitempty"` Limits Limits `json:"limits,omitempty"` + MaxRecvMsgSize int `json:"maxRecvMsgSize,omitempty"` + MaxSendMsgSize int `json:"maxSendMsgSize,omitempty"` } type Gossip struct { diff --git a/api/peer/v25/peer.go b/pkg/apis/peer/v25/peer.go similarity index 92% rename from api/peer/v25/peer.go rename to pkg/apis/peer/v25/peer.go index 0f2ba2d7..a26fd990 100644 --- a/api/peer/v25/peer.go +++ b/pkg/apis/peer/v25/peer.go @@ -19,9 +19,9 @@ package v25 import ( - "github.com/IBM-Blockchain/fabric-operator/api/common" - v1 "github.com/IBM-Blockchain/fabric-operator/api/peer/v1" - v2 "github.com/IBM-Blockchain/fabric-operator/api/peer/v2" + "github.com/IBM-Blockchain/fabric-operator/pkg/apis/common" + v1 "github.com/IBM-Blockchain/fabric-operator/pkg/apis/peer/v1" + v2 "github.com/IBM-Blockchain/fabric-operator/pkg/apis/peer/v2" ) type Core struct { @@ -61,6 +61,8 @@ type Peer struct { ValidatorPoolSize int `json:"validatorPoolSize,omitempty"` Discovery v1.Discovery `json:"discovery,omitempty"` Limits v2.Limits `json:"limits,omitempty"` + MaxRecvMsgSize int `json:"maxRecvMsgSize,omitempty"` + MaxSendMsgSize int `json:"maxSendMsgSize,omitempty"` } type Ledger struct { @@ -69,13 +71,6 @@ type Ledger struct { PvtDataStore PvtDataStore `json:"pvtdataStore,omitempty"` } -type Gateway struct { - Enabled *bool `json:"enabled,omitempty"` - EndorsementTimeout common.Duration `json:"endorsementTimeout,omitempty"` - DialTimeout common.Duration `json:"dialTimeout,omitempty"` - BroadcastTimeout common.Duration `json:"broadcastTimeout,omitempty"` -} - type PvtDataStore struct { CollElgProcMaxDbBatchSize int `json:"collElgProcMaxDbBatchSize,omitempty"` CollElgProcDbBatchesInterval int `json:"collElgProcDbBatchesInterval,omitempty"` @@ -83,3 +78,10 @@ type PvtDataStore struct { PurgeInterval int `json:"purgeInterval,omitempty"` PurgedKeyAuditLogging *bool `json:"purgedKeyAuditLogging,omitempty"` } + +type Gateway struct { + Enabled *bool `json:"enabled,omitempty"` + EndorsementTimeout common.Duration `json:"endorsementTimeout,omitempty"` + DialTimeout common.Duration `json:"dialTimeout,omitempty"` + BroadcastTimeout common.Duration `json:"broadcastTimeout,omitempty"` +} diff --git a/scripts/check-licenses.sh b/scripts/check-licenses.sh new file mode 100755 index 00000000..be98f622 --- /dev/null +++ b/scripts/check-licenses.sh @@ -0,0 +1,127 @@ +#!/bin/bash +# +# Copyright contributors to the Hyperledger Fabric Operator project +# +# SPDX-License-Identifier: Apache-2.0 +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +cat << EOB > golang_copyright.txt +/* + * Copyright contributors to the Hyperledger Fabric Operator project + * + * SPDX-License-Identifier: Apache-2.0 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +EOB + +cat << EOB > shell_copyright.txt +# +# Copyright contributors to the Hyperledger Fabric Operator project +# +# SPDX-License-Identifier: Apache-2.0 +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +EOB + +function filterGeneratedFiles { + for f in $@; do + head -n5 $f | grep -qE 'Code generated by.*DO NOT EDIT' || echo $f + done +} + +function filterExcludedFiles { + CHECK=`echo "$CHECK" \ + | grep -v "^\.git/" \ + | grep -v "^\.gitignore" \ + | grep -v "\.txt$" \ + | grep -v "vendor/" \ + | grep -v "go.mod" \ + | grep -v "go.sum" \ + | grep -v .deepcopy.go \ + | sort -u` + + CHECK=$(filterGeneratedFiles "$CHECK") +} + +CHECK=$(git diff --name-only --diff-filter=ACMRTUXB HEAD) +filterExcludedFiles +if [[ -z "$CHECK" ]]; then + CHECK=$(git diff-tree --no-commit-id --name-only --diff-filter=ACMRTUXB -r "HEAD^..HEAD") + filterExcludedFiles +fi + +if [[ -z "$CHECK" ]]; then + echo "All files are excluded from having license headers" + exit 0 +fi + +missing=`echo "$CHECK" | xargs ls -d 2>/dev/null | xargs grep -L "SPDX-License-Identifier: Apache-2.0"` +if [[ -z "$missing" ]]; then + echo "All files have SPDX-License-Identifier: Apache-2.0" + exit 0 +fi + +TMPFILE="./tmpfile" + +for FILE in ${missing}; do + EXT="${FILE##*.}" + echo "Adding copyright notice to $FILE" + if [ "${EXT}" = "go" ]; then + cat golang_copyright.txt ${FILE} > ${TMPFILE} + cat ${TMPFILE} > ${FILE} + rm -f ${TMPFILE} + echo " ${FILE} copyright notice added" + elif [ "${EXT}" = "yaml" ]; then + cat shell_copyright.txt ${FILE} > ${TMPFILE} + cat ${TMPFILE} > ${FILE} + rm -f ${TMPFILE} + echo " ${FILE} copyright notice added" + elif [ "${EXT}" = "sh" ]; then + cat shell_copyright.txt ${FILE} > ${TMPFILE} + cat ${TMPFILE} > ${FILE} + rm -f ${TMPFILE} + echo " ${FILE} copyright notice added" + else + echo "invalid file extension" + fi +done + +rm golang_copyright.txt shell_copyright.txt + +exit 0 \ No newline at end of file diff --git a/scripts/checks.sh b/scripts/checks.sh new file mode 100755 index 00000000..eb547d27 --- /dev/null +++ b/scripts/checks.sh @@ -0,0 +1,44 @@ +#!/bin/bash +# +# Copyright contributors to the Hyperledger Fabric Operator project +# +# SPDX-License-Identifier: Apache-2.0 +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +# Need to run this before go vet +go mod download + +echo "Running 'go vet'" +OUTPUT=`go vet -all ./... 2>&1` +if [ -n "$OUTPUT" ]; then + echo "The following files contain go vet errors" + echo $OUTPUT + exit 1 +fi +echo "No 'go vet' issues found" + +cd /tmp +go install golang.org/x/tools/cmd/goimports@ff88973b1e4e +cd - +echo "Checking imports ..." +found=`goimports -l \`find . -path ./vendor -prune -o -name "*.go" -print\` 2>&1` +found=$(echo "$found" | grep -v generated) +if [ "$found" != "" ]; then + echo "The following files have import problems:" + echo "$found" + echo "You may run 'goimports -w ' to fix each file." + exit 1 +fi +echo "All files are properly formatted" \ No newline at end of file diff --git a/scripts/copy_apis.sh b/scripts/copy_apis.sh new file mode 100755 index 00000000..556eab5d --- /dev/null +++ b/scripts/copy_apis.sh @@ -0,0 +1,68 @@ + +#!/bin/bash +# +# Copyright contributors to the Hyperledger Fabric Operations Console project +# +# SPDX-License-Identifier: Apache-2.0 +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +#!/bin/bash -e + +## delete the folder if already exists +rm -rf /tmp/fabric-operator + +## clone the main repo to temp directory and copy the files +git clone https://github.com/hyperledger-labs/fabric-operator.git /tmp/fabric-operator >/dev/null 2>&1 + +# copy CA config +cp -r /tmp/fabric-operator/pkg/apis/ca/v1/ca.go ../pkg/apis/ca/v1/ca.go + +# copy peer config +cp -r /tmp/fabric-operator/pkg/apis/peer/* ../pkg/apis/peer/. + +# copy orderer config +cp -r /tmp/fabric-operator/pkg/apis/orderer/* ../pkg/apis/orderer/. + +# copy console config +cp -r /tmp/fabric-operator/pkg/apis/console/* ../pkg/apis/console/. + +# copy common config +cp -r /tmp/fabric-operator/pkg/apis/common/* ../pkg/apis/common/ + +# copy deployer config - This is manual step +cp -r /tmp/fabric-operator/pkg/apis/deployer/* ../pkg/apis/deployer/ + +# copy v1beta1 specs +cp /tmp/fabric-operator/api/v1beta1/common_struct.go ../api/v1beta1/ +cp -r /tmp/fabric-operator/api/v1beta1/*_types.go ../api/v1beta1/. +cp /tmp/fabric-operator/api/v1beta1/zz_generated.deepcopy.go ../api/v1beta1/zz_generated.deepcopy.go + + +## We need structs only and not the implemtation and the corresponding imports +for file_path in ../pkg/apis/peer/v2/peer.go ../pkg/apis/deployer/deployer.go +do + + line_no=$(awk '/pkg\/util/{ print NR; exit }' ${file_path}) + sed -i ${line_no}d ${file_path} + line_no=$(awk '/func/{ print NR; exit }' ${file_path}) + line=$((line_no-1)) + + file_name=$(basename "$file_path") + cat ${file_path} | head -${line} > /tmp/${file_name} + mv /tmp/${file_name} ${file_path} +done + +## format the files +go fmt ../... \ No newline at end of file diff --git a/scripts/go-sec.sh b/scripts/go-sec.sh new file mode 100755 index 00000000..474e64e4 --- /dev/null +++ b/scripts/go-sec.sh @@ -0,0 +1,23 @@ +#!/bin/bash + +# +# Copyright contributors to the Hyperledger Fabric Operator project +# +# SPDX-License-Identifier: Apache-2.0 +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +curl -sfL https://raw.githubusercontent.com/securego/gosec/master/install.sh | sh -s -- -b $(go env GOPATH)/bin $RELEASE + +gosec ./... \ No newline at end of file