Skip to content

Commit 1d19d6c

Browse files
committed
updating links for CRAN
1 parent b76d8bf commit 1d19d6c

27 files changed

+126
-99
lines changed

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
\.Rxproj$
66
^\.Rproj\.user$
77
CONTRIBUTING.md
8+
SECURITY.md
89
drat.sh
910
.travis.yml
1011
^LICENSE\.md$

DESCRIPTION

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Package: AzureContainers
22
Title: Interface to 'Container Instances', 'Docker Registry' and 'Kubernetes' in 'Azure'
3-
Version: 1.3.2
3+
Version: 1.3.3
44
Authors@R: c(
55
person("Hong", "Ooi", , "[email protected]", role = c("aut", "cre")),
66
person("Bill", "Liang", role = "ctb", comment = "Assistance debugging MMLS on Kubernetes"),
77
person("Ramkumar", "Chandrasekaran", role = "ctb", comment = "Original blog article on Dockerising MMLS"),
88
person("Microsoft", role="cph")
99
)
10-
Description: An interface to container functionality in Microsoft's 'Azure' cloud: <https://azure.microsoft.com/en-us/product-categories/containers/>. Manage 'Azure Container Instance' (ACI), 'Azure Container Registry' (ACR) and 'Azure Kubernetes Service' (AKS) resources, push and pull images, and deploy services. On the client side, lightweight shells to the 'docker', 'docker-compose', 'kubectl' and 'helm' commandline tools are provided. Part of the 'AzureR' family of packages.
10+
Description: An interface to container functionality in Microsoft's 'Azure' cloud: <https://azure.microsoft.com/en-us/products/category/containers/>. Manage 'Azure Container Instance' (ACI), 'Azure Container Registry' (ACR) and 'Azure Kubernetes Service' (AKS) resources, push and pull images, and deploy services. On the client side, lightweight shells to the 'docker', 'docker-compose', 'kubectl' and 'helm' commandline tools are provided. Part of the 'AzureR' family of packages.
1111
URL: https://github.com/Azure/AzureContainers https://github.com/Azure/AzureR
1212
BugReports: https://github.com/Azure/AzureContainers/issues
1313
License: MIT + file LICENSE
@@ -34,4 +34,4 @@ Suggests:
3434
RestRserve,
3535
AzureKeyVault
3636
Roxygen: list(markdown=TRUE, r6=FALSE, old_usage=TRUE)
37-
RoxygenNote: 7.1.1
37+
RoxygenNote: 7.3.1

NEWS.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# AzureContainers 1.3.3
2+
3+
- Updated web links for CRAN
4+
15
# AzureContainers 1.3.2
26

37
- Add a `secure_env_vars` argument to the `create_aci()` method, to set secure environment variables in the instance. The values of these variables are not visible in the container's properties, eg when viewed in the Azure portal or via the CLI.
@@ -42,7 +46,7 @@
4246

4347
# AzureContainers 1.1.1
4448

45-
* Enable creating ACI and AKS instances with assigned managed identities. Note that this is still in preview for AKS; see the [Microsoft Docs page](https://docs.microsoft.com/en-us/azure/aks/use-managed-identity) for enabling this feature.
49+
* Enable creating ACI and AKS instances with assigned managed identities. Note that this is still in preview for AKS; see the [Microsoft Docs page](https://learn.microsoft.com/en-us/azure/aks/use-managed-identity) for enabling this feature.
4650

4751
# AzureContainers 1.1.0
4852

R/add_aci_methods.R

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,18 @@
2626
#' - `cores`: The number of CPU cores for the instance.
2727
#' - `memory`: The memory size in GB for the instance.
2828
#' - `os`: The operating system to run in the instance.
29-
#' - `command`: A list of commands to run in the instance. This is similar to the `--entrypoint` commandline argument to `docker run`; see [here](https://docs.microsoft.com/en-us/azure/container-instances/container-instances-start-command) for some examples.
29+
#' - `command`: A list of commands to run in the instance. This is similar to the `--entrypoint` commandline argument to `docker run`; see [here](https://learn.microsoft.com/en-us/azure/container-instances/container-instances-start-command) for some examples.
3030
#' - `env_vars`: A list of name-value pairs to set as environment variables in the instance.
3131
#' - `secure_env_vars`: A list of name-value pairs to set as _secure_ environment variables in the instance. The values of these variables are not visible in the container's properties, eg when viewed in the Azure portal or via the CLI.
3232
#' - `ports`: The network ports to open. By default, opens ports 80 and 443. See 'Details'.
3333
#' - `dns_name`: The domain name prefix for the instance. Only takes effect if `public_ip=TRUE`.
3434
#' - `public_ip`: Whether the instance should be publicly accessible.
3535
#' - `restart`: Whether to restart the instance should an event occur.
3636
#' - `managed_identity`: Whether to assign the container instance a managed identity.
37-
#' - `...`: Other named arguments to pass to the [az_resource] initialization function.
37+
#' - `...`: Other named arguments to pass to the [AzureRMR::az_resource] initialization function.
3838
#'
3939
#' @section Details:
40-
#' An ACI resource is a running container hosted in Azure. See the [documentation for the resource](https://docs.microsoft.com/en-us/azure/container-instances/) for more information. Currently ACI only supports a single image in an instance.
40+
#' An ACI resource is a running container hosted in Azure. See the [documentation for the resource](https://learn.microsoft.com/en-us/azure/container-instances/) for more information. Currently ACI only supports a single image in an instance.
4141
#'
4242
#' To supply the registry authentication credentials, the `registry_creds` argument should contain either an [ACR][acr] object, a [docker_registry] object, or the result of a call to the [aci_creds] function.
4343
#'
@@ -51,8 +51,8 @@
5151
#'
5252
#' [az_container_instance]
5353
#'
54-
#' [ACI documentation](https://docs.microsoft.com/en-us/azure/container-instances/) and
55-
#' [API reference](https://docs.microsoft.com/en-us/rest/api/container-instances/)
54+
#' [ACI documentation](https://learn.microsoft.com/en-us/azure/container-instances/) and
55+
#' [API reference](https://learn.microsoft.com/en-us/rest/api/container-instances/)
5656
#'
5757
#' [Docker commandline reference](https://docs.docker.com/engine/reference/commandline/cli/)
5858
#'
@@ -103,8 +103,8 @@ NULL
103103
#'
104104
#' [az_container_instance]
105105
#'
106-
#' [ACI documentation](https://docs.microsoft.com/en-us/azure/container-instances/) and
107-
#' [API reference](https://docs.microsoft.com/en-us/rest/api/container-instances/)
106+
#' [ACI documentation](https://learn.microsoft.com/en-us/azure/container-instances/) and
107+
#' [API reference](https://learn.microsoft.com/en-us/rest/api/container-instances/)
108108
#'
109109
#' [Docker commandline reference](https://docs.docker.com/engine/reference/commandline/cli/)
110110
#'
@@ -146,8 +146,8 @@ NULL
146146
#'
147147
#' [az_container_instance]
148148
#'
149-
#' [ACI documentation](https://docs.microsoft.com/en-us/azure/container-instances/) and
150-
#' [API reference](https://docs.microsoft.com/en-us/rest/api/container-instances/)
149+
#' [ACI documentation](https://learn.microsoft.com/en-us/azure/container-instances/) and
150+
#' [API reference](https://learn.microsoft.com/en-us/rest/api/container-instances/)
151151
#'
152152
#' [Docker commandline reference](https://docs.docker.com/engine/reference/commandline/cli/)
153153
#'

R/add_acr_methods.R

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616
#' - `admin_user_enabled`: Whether to enable the Admin user. Currently this must be `TRUE` for ACI to pull from the registry.
1717
#' - `sku`: Either "Basic", "Standard" (the default) or "Premium".
1818
#' - `wait`: Whether to wait until the ACR resource provisioning is complete.
19-
#' - `...`: Other named arguments to pass to the [az_resource] initialization function.
19+
#' - `...`: Other named arguments to pass to the [AzureRMR::az_resource] initialization function.
2020
#'
2121
#' @section Details:
22-
#' An ACR resource is a Docker registry hosted in Azure. See the [documentation for the resource](https://docs.microsoft.com/en-us/azure/container-registry/) for more information. To work with the registry (transfer images, retag images, etc) see the [documentation for the registry endpoint][docker_registry].
22+
#' An ACR resource is a Docker registry hosted in Azure. See the [documentation for the resource](https://learn.microsoft.com/en-us/azure/container-registry/) for more information. To work with the registry (transfer images, retag images, etc) see the [documentation for the registry endpoint][docker_registry].
2323
#'
2424
#' @section Value:
2525
#' An object of class `az_container_registry` representing the registry resource.
@@ -31,8 +31,8 @@
3131
#'
3232
#' [docker_registry] for the registry endpoint
3333
#'
34-
#' [ACR documentation](https://docs.microsoft.com/en-us/azure/container-registry/) and
35-
#' [API reference](https://docs.microsoft.com/en-us/rest/api/containerregistry/registries)
34+
#' [ACR documentation](https://learn.microsoft.com/en-us/azure/container-registry/) and
35+
#' [API reference](https://learn.microsoft.com/en-us/rest/api/containerregistry/registries)
3636
#'
3737
#' [Docker registry API](https://docs.docker.com/registry/spec/api/)
3838
#'
@@ -80,8 +80,8 @@ NULL
8080
#'
8181
#' [docker_registry] for the registry endpoint
8282
#'
83-
#' [ACR documentation](https://docs.microsoft.com/en-us/azure/container-registry/) and
84-
#' [API reference](https://docs.microsoft.com/en-us/rest/api/containerregistry/registries)
83+
#' [ACR documentation](https://learn.microsoft.com/en-us/azure/container-registry/) and
84+
#' [API reference](https://learn.microsoft.com/en-us/rest/api/containerregistry/registries)
8585
#'
8686
#' [Docker registry API](https://docs.docker.com/registry/spec/api/)
8787
#'
@@ -125,8 +125,8 @@ NULL
125125
#'
126126
#' [docker_registry] for the registry endpoint
127127
#'
128-
#' [ACR documentation](https://docs.microsoft.com/en-us/azure/container-registry/) and
129-
#' [API reference](https://docs.microsoft.com/en-us/rest/api/containerregistry/registries)
128+
#' [ACR documentation](https://learn.microsoft.com/en-us/azure/container-registry/) and
129+
#' [API reference](https://learn.microsoft.com/en-us/rest/api/containerregistry/registries)
130130
#'
131131
#' [Docker registry API](https://docs.docker.com/registry/spec/api/)
132132
#'

R/add_aks_methods.R

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
#'
3636
#' The nodes for an AKS cluster are organised into _agent pools_, also known as _node pools_, which are homogenous groups of virtual machines. To specify the details for a single agent pool, use the `agent_pool` function, which returns an S3 object of that class. To specify the details for multiple pools, you can supply a list of such objects, or a single call to the `aks_pools` function; see the examples below. Note that `aks_pools` is older, and does not support all the possible parameters for an agent pool.
3737
#'
38-
#' Of the agent pools in a cluster, at least one must be a _system pool_, which is used to host critical system pods such as CoreDNS and tunnelfront. If you specify more than one pool, the first pool will be treated as the system pool. Note that there are certain [extra requirements](https://docs.microsoft.com/en-us/azure/aks/use-system-pools) for the system pool.
38+
#' Of the agent pools in a cluster, at least one must be a _system pool_, which is used to host critical system pods such as CoreDNS and tunnelfront. If you specify more than one pool, the first pool will be treated as the system pool. Note that there are certain [extra requirements](https://learn.microsoft.com/en-us/azure/aks/use-system-pools) for the system pool.
3939
#'
4040
#' An AKS cluster requires an identity to manage the low-level resources it uses, such as virtual machines and networks. The default and recommended method is to use a _managed identity_, in which all the details of this process are handled by AKS. In AzureContainers version 1.2.1 and older, a _service principal_ was used instead, which is an older and less automated method. By setting `managed_identity=FALSE`, you can continue using a service principal instead of a managed identity.
4141
#'
@@ -51,8 +51,8 @@
5151
#'
5252
#' [kubernetes_cluster] for the cluster endpoint
5353
#'
54-
#' [AKS documentation](https://docs.microsoft.com/en-us/azure/aks/) and
55-
#' [API reference](https://docs.microsoft.com/en-us/rest/api/aks/)
54+
#' [AKS documentation](https://learn.microsoft.com/en-us/azure/aks/) and
55+
#' [API reference](https://learn.microsoft.com/en-us/rest/api/aks/)
5656
#'
5757
#' [Kubernetes reference](https://kubernetes.io/docs/reference/)
5858
#'
@@ -113,8 +113,8 @@ NULL
113113
#'
114114
#' [kubernetes_cluster] for the cluster endpoint
115115
#'
116-
#' [AKS documentation](https://docs.microsoft.com/en-us/azure/aks/) and
117-
#' [API reference](https://docs.microsoft.com/en-us/rest/api/aks/)
116+
#' [AKS documentation](https://learn.microsoft.com/en-us/azure/aks/) and
117+
#' [API reference](https://learn.microsoft.com/en-us/rest/api/aks/)
118118
#'
119119
#' [Kubernetes reference](https://kubernetes.io/docs/reference/)
120120
#'
@@ -158,8 +158,8 @@ NULL
158158
#'
159159
#' [kubernetes_cluster] for the cluster endpoint
160160
#'
161-
#' [AKS documentation](https://docs.microsoft.com/en-us/azure/aks/) and
162-
#' [API reference](https://docs.microsoft.com/en-us/rest/api/aks/)
161+
#' [AKS documentation](https://learn.microsoft.com/en-us/azure/aks/) and
162+
#' [API reference](https://learn.microsoft.com/en-us/rest/api/aks/)
163163
#'
164164
#' [Kubernetes reference](https://kubernetes.io/docs/reference/)
165165
#'

R/az_container_instance.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010
#' - `stop()`: Stop a container.
1111
#'
1212
#' @section Details:
13-
#' Initializing a new object of this class can either retrieve an existing ACI resource, or create a new resource on the host. Generally, the best way to initialize an object is via the `get_aci`, `create_aci` or `list_acis` methods of the [az_resource_group] class, which handle the details automatically.
13+
#' Initializing a new object of this class can either retrieve an existing ACI resource, or create a new resource on the host. Generally, the best way to initialize an object is via the `get_aci`, `create_aci` or `list_acis` methods of the [AzureRMR::az_resource_group] class, which handle the details automatically.
1414
#'
1515
#' @seealso
1616
#' [acr], [aks]
1717
#'
18-
#' [ACI documentation](https://docs.microsoft.com/en-us/azure/container-instances/) and
19-
#' [API reference](https://docs.microsoft.com/en-us/rest/api/container-instances/)
18+
#' [ACI documentation](https://learn.microsoft.com/en-us/azure/container-instances/) and
19+
#' [API reference](https://learn.microsoft.com/en-us/rest/api/container-instances/)
2020
#'
2121
#' [Docker commandline reference](https://docs.docker.com/engine/reference/commandline/cli/)
2222
#'

R/az_container_registry.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
#' - `get_docker_registry(username, password)`: Return an object representing the Docker registry endpoint.
1414
#'
1515
#' @section Details:
16-
#' Initializing a new object of this class can either retrieve an existing registry resource, or create a new registry on the host. Generally, the best way to initialize an object is via the `get_acr`, `create_acr` or `list_acrs` methods of the [az_resource_group] class, which handle the details automatically.
16+
#' Initializing a new object of this class can either retrieve an existing registry resource, or create a new registry on the host. Generally, the best way to initialize an object is via the `get_acr`, `create_acr` or `list_acrs` methods of the [AzureRMR::az_resource_group] class, which handle the details automatically.
1717
#'
1818
#' Note that this class is separate from the Docker registry itself. This class exposes methods for working with the Azure resource: listing credentials, updating resource tags, updating and deleting the resource, and so on.
1919
#'
@@ -29,8 +29,8 @@
2929
#'
3030
#' [docker_registry] for interacting with the Docker registry endpoint
3131
#'
32-
#' [Azure Container Registry](https://docs.microsoft.com/en-us/azure/container-registry/) and
33-
#' [API reference](https://docs.microsoft.com/en-us/rest/api/containerregistry/registries)
32+
#' [Azure Container Registry](https://learn.microsoft.com/en-us/azure/container-registry/) and
33+
#' [API reference](https://learn.microsoft.com/en-us/rest/api/containerregistry/registries)
3434
#'
3535
#' @examples
3636
#' \dontrun{

R/az_kubernetes_service.R

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
#' - `update_service_password(name=NULL, duration=NULL, ...)`: Update the password for the service principal used to manage the cluster resources, returning the new password invisibly. See 'Updating credentials' below.
1717
#'
1818
#' @section Details:
19-
#' Initializing a new object of this class can either retrieve an existing AKS resource, or create a new resource on the host. Generally, the best way to initialize an object is via the `get_aks`, `create_aks` or `list_aks` methods of the [az_resource_group] class, which handle the details automatically.
19+
#' Initializing a new object of this class can either retrieve an existing AKS resource, or create a new resource on the host. Generally, the best way to initialize an object is via the `get_aks`, `create_aks` or `list_aks` methods of the [AzureRMR::az_resource_group] class, which handle the details automatically.
2020
#'
2121
#' Note that this class is separate from the Kubernetes cluster itself. This class exposes methods for working with the Azure resource: updating resource tags, updating and deleting the resource (including updating the Kubernetes version), and so on.
2222
#'
@@ -39,8 +39,8 @@
3939
#'
4040
#' [kubernetes_cluster] for interacting with the cluster endpoint
4141
#'
42-
#' [AKS documentation](https://docs.microsoft.com/en-us/azure/aks/) and
43-
#' [API reference](https://docs.microsoft.com/en-us/rest/api/aks/)
42+
#' [AKS documentation](https://learn.microsoft.com/en-us/azure/aks/) and
43+
#' [API reference](https://learn.microsoft.com/en-us/rest/api/aks/)
4444
#'
4545
#' @examples
4646
#' \dontrun{
@@ -212,7 +212,7 @@ public=list(
212212
#' @seealso
213213
#' [create_aks], [list_vm_sizes]
214214
#'
215-
#' [Agent pool parameters on Microsoft Docs](https://docs.microsoft.com/en-us/rest/api/aks/managedclusters/createorupdate#managedclusteragentpoolprofile)
215+
#' [Agent pool parameters on Microsoft Docs](https://learn.microsoft.com/en-us/rest/api/aks/managedclusters/createorupdate#managedclusteragentpoolprofile)
216216
#'
217217
#' @examples
218218
#' # pool of 5 Linux GPU-enabled VMs

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
![Downloads](https://cranlogs.r-pkg.org/badges/AzureContainers)
55
![R-CMD-check](https://github.com/Azure/AzureContainers/workflows/R-CMD-check/badge.svg)
66

7-
A package for working with [Azure Container Registry (ACR)](https://azure.microsoft.com/en-us/services/container-registry/), [Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-us/services/kubernetes-service/) and [Azure Container Instances (ACI)](https://azure.microsoft.com/en-us/services/container-instances/). Extends the Azure Resource Manager interface provided by the [AzureRMR](https://github.com/Azure/AzureRMR) package.
7+
A package for working with [Azure Container Registry (ACR)](https://azure.microsoft.com/en-us/products/container-registry/), [Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-us/products/kubernetes-service/) and [Azure Container Instances (ACI)](https://azure.microsoft.com/en-us/products/container-instances/). Extends the Azure Resource Manager interface provided by the [AzureRMR](https://github.com/Azure/AzureRMR) package.
88

99
AzureContainers lets you build and deploy containerised services in R, using Docker and Kubernetes. For full functionality, you should have [Docker](https://docs.docker.com/install/) installed, as well as the [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) and [helm](https://helm.sh/) commandline tools. Otherwise it is relatively lightweight, requiring neither Powershell nor Python.
1010

0 commit comments

Comments
 (0)