container-registry-go-sdk

README

IBM Cloud Container Registry Go SDK 1.1.3

Go client library to interact with the IBM Cloud Container Registry API, and IBM Cloud Container Registry Vulnerability Advisor API

Table of Contents

• Overview
• Prerequisites
• Installation
  • go get command
  • Go modules
  • dep dependency manager
• Using the SDK
• Questions
• Issues
• Open source @ IBM
• Contributing
• License

Overview

The IBM Cloud Container Registry Go SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name	Package name
Container Registry image management API	containerregistryv1
Container Registry Vulnerability Advisor API	vulnerabilityadvisorv4

Prerequisites

• An IBM Cloud account.
• An IAM API key to allow the SDK to access your account. Create one here.
• Go version 1.18 or above.

Installation

The current version of this SDK: 1.1.3

There are a few different ways to download and install the Container Registry Go SDK project for use by your Go application:

go get command

Use this command to download and install the SDK to allow your Go application to use it:

go get github.com/IBM/container-registry-go-sdk

Go modules

If your application is using Go modules, you can add a suitable import to your Go application, like this:

import (
  "github.com/IBM/container-registry-go-sdk/containerregistryv1"
  "github.com/IBM/container-registry-go-sdk/vulnerabilityadvisorv4"
)

then run go mod tidy to download and install the new dependency and update your Go application's go.mod file.

dep dependency manager

If your application is using the dep dependency management tool, you can add a dependency to your Gopkg.toml file. Here is an example:

[[constraint]]
  name = "github.com/IBM/container-registry-go-sdk"
  version = "1.1.3"

then run dep ensure.

Using the SDK

For general SDK usage information, please see this link

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.

Issues

If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.

License

This SDK project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.