Chapter 4. Configuring metering

Procedure

1. Edit the spec.storage section in the s3-storage.yaml file:

   Example s3-storage.yaml file

   apiVersion: metering.openshift.io/v1
   kind: MeteringConfig
   metadata:
     name: "operator-metering"
   spec:
     storage:
       type: "hive"
       hive:
         type: "s3"
         s3:
           bucket: "bucketname/path/" 

   1

   
           region: "us-west-1" 

   2

   
           secretName: "my-aws-secret" 

   3

   
           # Set to false if you want to provide an existing bucket, instead of
           # having metering create the bucket on your behalf.
           createBucket: true 

   4

   1

   Specify the name of the bucket where you would like to store your data. Optional: Specify the path within the bucket.

   2

   Specify the region of your bucket.

   3

   The name of a secret in the metering namespace containing the AWS credentials in the data.aws-access-key-id and data.aws-secret-access-key fields. See the example Secret object below for more details.

   4

   Set this field to false if you want to provide an existing S3 bucket, or if you do not want to provide IAM credentials that have CreateBucket permissions.

2. Use the following Secret object as a template:

   Example AWS Secret object

   apiVersion: v1
   kind: Secret
   metadata:
     name: my-aws-secret
   data:
     aws-access-key-id: "dGVzdAo="
     aws-secret-access-key: "c2VjcmV0Cg=="

   Note

   The values of the aws-access-key-id and aws-secret-access-key must be base64 encoded.

3. Create the secret:

   $ oc create secret -n openshift-metering generic my-aws-secret \
     --from-literal=aws-access-key-id=my-access-key \
     --from-literal=aws-secret-access-key=my-secret-key

   Note

   This command automatically base64 encodes your aws-access-key-id and aws-secret-access-key values.

Procedure

1. Edit the spec.storage section in the s3-compatible-storage.yaml file:

   Example s3-compatible-storage.yaml file

   apiVersion: metering.openshift.io/v1
   kind: MeteringConfig
   metadata:
     name: "operator-metering"
   spec:
     storage:
       type: "hive"
       hive:
         type: "s3Compatible"
         s3Compatible:
           bucket: "bucketname" 

   1

   
           endpoint: "http://example:port-number" 

   2

   
           secretName: "my-aws-secret" 

   3

   1

   Specify the name of your S3-compatible bucket.

   2

   Specify the endpoint for your storage.

   3

   The name of a secret in the metering namespace containing the AWS credentials in the data.aws-access-key-id and data.aws-secret-access-key fields. See the example Secret object below for more details.

2. Use the following Secret object as a template:

   Example S3-compatible Secret object

   apiVersion: v1
   kind: Secret
   metadata:
     name: my-aws-secret
   data:
     aws-access-key-id: "dGVzdAo="
     aws-secret-access-key: "c2VjcmV0Cg=="

Procedure

1. Edit the spec.storage section in the azure-blob-storage.yaml file:

   Example azure-blob-storage.yaml file

   apiVersion: metering.openshift.io/v1
   kind: MeteringConfig
   metadata:
     name: "operator-metering"
   spec:
     storage:
       type: "hive"
       hive:
         type: "azure"
         azure:
           container: "bucket1" 

   1

   
           secretName: "my-azure-secret" 

   2

   
           rootDirectory: "/testDir" 

   3

   1

   Specify the container name.

   2

   Specify a secret in the metering namespace. See the example Secret object below for more details.

   3

   Optional: Specify the directory where you would like to store your data.

2. Use the following Secret object as a template:

   Example Azure Secret object

   apiVersion: v1
   kind: Secret
   metadata:
     name: my-azure-secret
   data:
     azure-storage-account-name: "dGVzdAo="
     azure-secret-access-key: "c2VjcmV0Cg=="

3. Create the secret:

   $ oc create secret -n openshift-metering generic my-azure-secret \
     --from-literal=azure-storage-account-name=my-storage-account-name \
     --from-literal=azure-secret-access-key=my-secret-key

Procedure

1. Edit the spec.storage section in the gcs-storage.yaml file:

   Example gcs-storage.yaml file

   apiVersion: metering.openshift.io/v1
   kind: MeteringConfig
   metadata:
     name: "operator-metering"
   spec:
     storage:
       type: "hive"
       hive:
         type: "gcs"
         gcs:
           bucket: "metering-gcs/test1" 

   1

   
           secretName: "my-gcs-secret" 

   2

   1

   Specify the name of the bucket. You can optionally specify the directory within the bucket where you would like to store your data.

   2

   Specify a secret in the metering namespace. See the example Secret object below for more details.

2. Use the following Secret object as a template:

   Example Google Cloud Storage Secret object

   apiVersion: v1
   kind: Secret
   metadata:
     name: my-gcs-secret
   data:
     gcs-service-account.json: "c2VjcmV0Cg=="

3. Create the secret:

   $ oc create secret -n openshift-metering generic my-gcs-secret \
     --from-file gcs-service-account.json=/path/to/my/service-account-key.json

Procedure

1. Modify the shared-storage.yaml file to use a ReadWriteMany persistent volume for storage:

   apiVersion: metering.openshift.io/v1
   kind: MeteringConfig
   metadata:
     name: "operator-metering"
   spec:
     storage:
       type: "hive"
       hive:
         type: "sharedPVC"
         sharedPVC:
           claimName: "metering-nfs" 

   1

   
           # Uncomment the lines below to provision a new PVC using the specified storageClass. 

   2

   
           # createPVC: true
           # storageClass: "my-nfs-storage-class"
           # size: 5Gi

   Select one of the configuration options below:

   1

   Set storage.hive.sharedPVC.claimName to the name of an existing ReadWriteMany persistent volume claim (PVC). This configuration is necessary if you do not have dynamic volume provisioning or want to have more control over how the persistent volume is created.

   2

   Set storage.hive.sharedPVC.createPVC to true and set the storage.hive.sharedPVC.storageClass to the name of a storage class with ReadWriteMany access mode. This configuration uses dynamic volume provisioning to create a volume automatically.

2. Create the following resource objects that are required to deploy an NFS server for metering. Use the oc create -f <file-name>.yaml command to create the object YAML files.

   1. Configure a PersistentVolume resource object:

      Example nfs_persistentvolume.yaml file

      apiVersion: v1
      kind: PersistentVolume
      metadata:
        name: nfs
        labels:
          role: nfs-server
      spec:
        capacity:
          storage: 5Gi
        accessModes:
        - ReadWriteMany
        storageClassName: nfs-server 

      1

      
        nfs:
          path: "/"
          server: REPLACEME
        persistentVolumeReclaimPolicy: Delete

      1

      Must exactly match the [kind: StorageClass].metadata.name field value.

   2. Configure a Pod resource object with the nfs-server role:

      Example nfs_server.yaml file

      apiVersion: v1
      kind: Pod
      metadata:
        name: nfs-server
        labels:
          role: nfs-server
      spec:
        containers:
          - name: nfs-server
            image: <image_name> 

      1

      
            imagePullPolicy: IfNotPresent
            ports:
              - name: nfs
                containerPort: 2049
            securityContext:
              privileged: true
            volumeMounts:
            - mountPath: "/mnt/data"
              name: local
        volumes:
          - name: local
            emptyDir: {}

      1

      Install your NFS server image.

   3. Configure a Service resource object with the nfs-server role:

      Example nfs_service.yaml file

      apiVersion: v1
      kind: Service
      metadata:
        name: nfs-service
        labels:
          role: nfs-server
      spec:
        ports:
        - name: 2049-tcp
          port: 2049
          protocol: TCP
          targetPort: 2049
        selector:
          role: nfs-server
        sessionAffinity: None
        type: ClusterIP

   4. Configure a StorageClass resource object:

      Example nfs_storageclass.yaml file

      apiVersion: storage.k8s.io/v1
      kind: StorageClass
      metadata:
        name: nfs-server 

      1

      
      provisioner: example.com/nfs
      parameters:
        archiveOnDelete: "false"
      reclaimPolicy: Delete
      volumeBindingMode: Immediate

      1

      Must exactly match the [kind: PersistentVolume].spec.storageClassName field value.

Procedure

1. Create a secret using the OpenShift CLI (oc) or by using a YAML file:

   • Create a secret by using the following command:

     $ oc --namespace openshift-metering create secret generic <YOUR_SECRETNAME> --from-literal=username=<YOUR_DATABASE_USERNAME> --from-literal=password=<YOUR_DATABASE_PASSWORD>

   • Create a secret by using a YAML file. For example:

     apiVersion: v1
     kind: Secret
     metadata:
       name: <YOUR_SECRETNAME> 

     1

     
     data:
       username: <BASE64_ENCODED_DATABASE_USERNAME> 

     2

     
       password: <BASE64_ENCODED_DATABASE_PASSWORD> 

     3

     1

     The name of the secret.

     2

     Base64 encoded database user name.

     3

     Base64 encoded database password.

2. Create a configuration file to use a MySQL or PostgreSQL database for Hive:

   • To use a MySQL database for Hive, use the example configuration file below. Metering supports configuring the internal Hive metastore to use the MySQL server versions 5.6, 5.7, and 8.0.

     spec:
       hive:
         spec:
           metastore:
             storage:
               create: false
           config:
             db:
               url: "jdbc:mysql://mysql.example.com:3306/hive_metastore" 

     1

     
               driver: "com.mysql.cj.jdbc.Driver"
               secretName: "REPLACEME" 

     2

     Note

     When configuring Metering to work with older MySQL server versions, such as 5.6 or 5.7, you might need to add the enabledTLSProtocols JDBC URL parameter when configuring the internal Hive metastore.

     1

     To use the TLS v1.2 cipher suite, set url to "jdbc:mysql://<hostname>:<port>/<schema>?enabledTLSProtocols=TLSv1.2".

     2

     The name of the secret containing the base64-encrypted user name and password database credentials.

     You can pass additional JDBC parameters using the spec.hive.config.url. For more details, see the MySQL Connector/J 8.0 documentation.

   • To use a PostgreSQL database for Hive, use the example configuration file below:

     spec:
       hive:
         spec:
           metastore:
             storage:
               create: false
           config:
             db:
               url: "jdbc:postgresql://postgresql.example.com:5432/hive_metastore"
               driver: "org.postgresql.Driver"
               username: "REPLACEME"
               password: "REPLACEME"

     You can pass additional JDBC parameters using the spec.hive.config.url. For more details, see the PostgreSQL JDBC driver documentation.