Skip to content

Commit

Permalink
Clean up README, bump Artifactory docker image version, etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexhung committed Jan 11, 2024
1 parent 685b16a commit 578ccc9
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 24 deletions.
22 changes: 7 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

## Releases

Current provider major release: **9.x**
Current provider major release: **10.x**

See [CHANGELOG.md](CHANGELOG.md) for full details

Expand All @@ -19,14 +19,11 @@ Version 6.x is compatible with the Artifactory versions 7.49.x and below.

Version 7.x and 8.x is only compatible with Artifactory between 7.50.x and 7.67.x due to changes in the projects functionality.

Version 9.x is the latest major version and is compatible with latest Artifactory versions (>=7.68.7 (self-hosted) and >=7.67.0 (cloud)).
Version 10.x is the latest major version and is compatible with latest Artifactory versions (>=7.68.7 (self-hosted) and >=7.67.0 (cloud)).

## Terraform CLI version support

Current version support [Terraform Protocol v5](https://developer.hashicorp.com/terraform/plugin/terraform-plugin-protocol#protocol-version-5) which mean Terraform CLI version 0.12 and later.

> [!WARNING]
> We will be moving to [Terraform Protocol v6](https://developer.hashicorp.com/terraform/plugin/terraform-plugin-protocol#protocol-version-6) in **Q1 2024**. This means only Terraform CLI version 1.0 and later will be supported.
Current version support [Terraform Protocol v6](https://developer.hashicorp.com/terraform/plugin/terraform-plugin-protocol#protocol-version-6) which mean Terraform CLI version 1.0 and later.

## Quick Start

Expand All @@ -35,18 +32,18 @@ Create a new Terraform file with `artifactory` resources. Also see [sample.tf](.
<details><summary>HCL Example</summary>

```terraform
# Required for Terraform 0.13 and up (https://www.terraform.io/upgrade-guides/0-13.html)
# Required for Terraform 1.0 and up (https://www.terraform.io/upgrade-guides)
terraform {
required_providers {
artifactory = {
source = "registry.terraform.io/jfrog/artifactory"
version = "6.6.1"
version = "10.0.2"
}
}
}
provider "artifactory" {
// supply ARTIFACTORY_USERNAME, ARTIFACTORY_ACCESS_TOKEN, and ARTIFACTORY_URL as env vars
// supply JFROG_ACCESS_TOKEN, and JFROG_URL as env vars
}
resource "artifactory_local_pypi_repository" "pypi-local" {
Expand Down Expand Up @@ -110,11 +107,6 @@ $ curl -sL ${host}/artifactory/api/system/licenses/ | jq .
}
```

The following 3 license types (`jq .type`) do **NOT** support APIs:
- Community Edition for C/C++
- JCR Edition
- OSS

## Versioning

In general, this project follows [Terraform Versioning Specification](https://www.terraform.io/plugin/sdkv2/best-practices/versioning#versioning-specification) as closely as we can for tagging releases of the package.
Expand All @@ -128,7 +120,7 @@ See the [contribution guide](CONTRIBUTIONS.md).

## License

Copyright (c) 2023 JFrog.
Copyright (c) 2024 JFrog.

Apache 2.0 licensed, see [LICENSE][LICENSE] file.

Expand Down
14 changes: 7 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,16 @@ curl -sL ${host}/artifactory/api/system/licenses/ | jq .

## Terraform CLI version support

Current version support [Terraform Protocol v5](https://developer.hashicorp.com/terraform/plugin/terraform-plugin-protocol#protocol-version-5) which mean Terraform CLI version 0.12 and later.

~>We will be moving to [Terraform Protocol v6](https://developer.hashicorp.com/terraform/plugin/terraform-plugin-protocol#protocol-version-6) in **Q1 2024**. This means only Terraform CLI version 1.0 and later will be supported.
Current version support [Terraform Protocol v6](https://developer.hashicorp.com/terraform/plugin/terraform-plugin-protocol#protocol-version-6) which mean Terraform CLI version 1.0 and later.

## Example Usage
```tf
# Required for Terraform 0.13 and up (https://www.terraform.io/upgrade-guides/0-13.html)
# Required for Terraform 1.0 and up (https://www.terraform.io/upgrade-guides)
terraform {
required_providers {
artifactory = {
source = "registry.terraform.io/jfrog/artifactory"
version = "9.7.0"
version = "10.0.2"
}
}
}
Expand All @@ -50,11 +48,13 @@ resource "artifactory_local_pypi_repository" "pypi-libs" {
```

## Authentication

The Artifactory provider supports two ways of authentication. The following methods are supported:
* Access Token
* API Key
* API Key (deprecated)

### Access Token

Artifactory access tokens may be used via the Authorization header by providing the `access_token` attribute to the provider block. Getting this value from the environment is supported with `JFROG_ACCESS_TOKEN` or `ARTIFACTORY_ACCESS_TOKEN` variables.

Usage:
Expand All @@ -66,7 +66,7 @@ provider "artifactory" {
}
```

### API Key
### API Key (deprecated)

!>An upcoming version will support the option to block the usage/creation of API Keys (for admins to set on their platform). In a future version (scheduled for end of Q3, 2023), the option to disable the usage/creation of API Keys will be available and set to disabled by default. Admins will be able to enable the usage/creation of API Keys. By end of Q1 2024, API Keys will be deprecated all together and the option to use them will no longer be available. See [JFrog API Key Deprecation Process](https://jfrog.com/help/r/jfrog-platform-administration-documentation/jfrog-api-key-deprecation-process).

Expand Down
2 changes: 1 addition & 1 deletion sample.tf
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ terraform {
required_providers {
artifactory = {
source = "registry.terraform.io/jfrog/artifactory"
version = "9.7.3"
version = "10.0.2"
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion scripts/run-artifactory.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" > /dev/null && pwd )"
source "${SCRIPT_DIR}/get-access-key.sh"
source "${SCRIPT_DIR}/wait-for-rt.sh"
export ARTIFACTORY_VERSION=${ARTIFACTORY_VERSION:-7.59.9}
export ARTIFACTORY_VERSION=${ARTIFACTORY_VERSION:-7.71.4}
echo "ARTIFACTORY_VERSION=${ARTIFACTORY_VERSION}"

set -euf
Expand Down

0 comments on commit 578ccc9

Please sign in to comment.